Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListDeliveryStreams

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.

Request Syntax


{
   "DeliveryStreamType": "string",
   "ExclusiveStartDeliveryStreamName": "string",
   "Limit": number
}

Request Parameters

The request accepts the following data in JSON format.

DeliveryStreamType

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.

Type: String

Valid Values: DirectPut | KinesisStreamAsSource | MSKAsSource | DatabaseAsSource

Required: No

ExclusiveStartDeliveryStreamName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: No

Limit

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: No

Response Syntax


{
   "DeliveryStreamNames": [ "string" ],
   "HasMoreDeliveryStreams": boolean
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeliveryStreamNames

The names of the Firehose streams.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

HasMoreDeliveryStreams

Indicates whether there are more Firehose streams available to list.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

The following JSON example lists up to three Firehose streams configured for DirectPut. The response indicates that there are more DirectPut Firehose streams to be listed. To list the remaining DirectPut Firehose streams, set DeliveryStreamType to DirectPut and ExclusiveStartDeliveryStreamName to last_stream_in_first_listing, and then run the operation again.

Sample Request


POST / HTTP/1.1
Host: firehose.<region>.<domain>
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Authorization: <AuthParams>
Connection: Keep-Alive 
X-Amz-Date: <Date>
X-Amz-Target: Firehose_20150804.ListDeliveryStreams 
{
    "DeliveryStreamType": "DirectPut",
    "Limit": 3
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "DeliveryStreamNames": [
        "some_delivery_stream",
        "another_example_delivery_stream",
        "last_stream_in_first_listing"
    ],
    "HasMoreDeliveryStreams": true
}