Describe Stream
firehose.describe_delivery_stream
ActionAmazon Web Servicesconnection required
Calls the AWS firehose API (SigV4).
Read a delivery stream's status and type.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon Data Firehose
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
delivery_stream_name Name of the delivery stream to act on, as Firehose spells it. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
delivery_stream_name | string | — |
arn | string | — |
status | string | — |
type | string | — |
version_id The stream's current version; UpdateDestination requires it. | string | — |
destination_ids Destination ids on this stream — the other half of an UpdateDestination call. | array | — |
has_more_destinations True when the vendor returned only part of the destination list. | boolean | — |
create_timestamp When the stream was created, epoch seconds. | number | — |
last_update_timestamp When the stream was last changed, epoch seconds. | number | — |
failure_type Why a CREATING_FAILED / DELETING_FAILED status. | string | — |
failure_details The vendor's detail text for that failure. | string | — |
encryption_status Server-side encryption state of the stream. | string | — |
encryption_key_arn KMS key ARN when encryption is customer-keyed. | string | — |
{
"arn": "",
"create_timestamp": 0,
"delivery_stream_name": "",
"destination_ids": [],
"encryption_key_arn": "",
"encryption_status": "",
"failure_details": "",
"failure_type": "",
"has_more_destinations": false,
"last_update_timestamp": 0,
"status": "",
"type": "",
"version_id": ""
}Related Amazon Data Firehose nodes
See Describe Stream run in a workflow.
In a technical demo we add the Amazon Data Firehose connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.