AWS Kinesis DescribeStream API
The DescribeStream API from AWS Kinesis — 1 operation(s) for describestream.
AWS Kinesis DescribeStream API is one of 100 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include DescribeStream. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.
This API exposes 1 operation across 1 path, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 2015-08-04.
Requests are made against 4 base URLs: http://firehose.{region}.amazonaws.com, https://firehose.{region}.amazonaws.com, http://firehose.{region}.amazonaws.com.cn, https://firehose.{region}.amazonaws.com.cn.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS Kinesis DescribeStream API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 15
The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are StreamInfo (9 properties), DescribeStreamOutput (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AWS Kinesis 12
Other APIs AWS Kinesis publishes across the network.