Describe Stream
kinesis.describe_stream
ActionAmazon Web Servicesconnection required
Calls the AWS kinesis API (SigV4).
Read a stream's status and shard count.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- AWS Kinesis
- 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 | — | — | — |
stream_name Name of the stream to act on, as Kinesis spells it. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
stream_name | string | — |
stream_arn | string | — |
status | string | — |
shard_count | number | — |
{
"shard_count": 0,
"status": "",
"stream_arn": "",
"stream_name": ""
}Related AWS Kinesis nodes
See Describe Stream run in a workflow.
In a technical demo we add the AWS Kinesis connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.