Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Kinesis #X Amz Target=Kinesis 20131202.DescribeStream API

The #X Amz Target=Kinesis 20131202.DescribeStream API from AWS Kinesis — 1 operation(s) for #x amz target=kinesis 20131202.describestream.

AWS Kinesis #X Amz Target=Kinesis 20131202.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 #X Amz Target=Kinesis 20131202.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 29 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.

1 operations 1 paths 29 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-08-04
Base URL
https://kinesis.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Kinesis #X Amz Target=Kinesis 20131202.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.

#X Amz Target=Kinesis 20131202.DescribeStream 1
POST
/#X-Amz-Target=Kinesis_20131202.DescribeStream
Describes the specified Kinesis data stream. This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis dat…
DescribeStream 10 params body → 200480481482483

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are StreamDescription (11 properties), Shard (5 properties), DescribeStreamInput (4 properties), HashKeyRange (2 properties). Each schema is shown below with its type and property counts.

ShardList
array
DescribeStreamInput
object
Represents the input for DescribeStream .
4 properties
SequenceNumberRange
object
The range of possible sequence numbers for the shard.
2 properties 1 required
KeyId
string
StreamMode
string
SequenceNumber
string
DescribeStreamInputLimit
integer
AccessDeniedException
InvalidArgumentException
HashKey
string
BooleanObject
boolean
LimitExceededException
StreamARN
string
ResourceNotFoundException
EnhancedMonitoringList
array
StreamDescription
object
Represents the output for DescribeStream .
11 properties 8 required
StreamModeDetails
object
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode an…
1 property 1 required
RetentionPeriodHours
integer
EnhancedMetrics
object
Represents enhanced metrics types.
1 property
MetricsNameList
array
StreamName
string
MetricsName
string
EncryptionType
string
StreamStatus
string
HashKeyRange
object
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
2 properties 2 required
Timestamp
string
ShardId
string
DescribeStreamOutput
object
Represents the output for DescribeStream .
1 property 1 required
Shard
object
A uniquely identified group of data records in a Kinesis data stream.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-x-amz-target-kinesis-20131202-describestream-api-openapi.yml Raw ↑

Other APIs AWS Kinesis publishes across the network.

Amazon Managed Service for Apache Flink API
AWS Kinesis CreateSignalingChannel API
AWS Kinesis CreateStream API
AWS Kinesis DeleteSignalingChannel API
AWS Kinesis DeleteStream API
AWS Kinesis DescribeEdgeConfiguration API
AWS Kinesis DescribeImageGenerationConfiguration API
AWS Kinesis DescribeMappedResourceConfiguration API
AWS Kinesis DescribeMediaStorageConfiguration API
AWS Kinesis DescribeNotificationConfiguration API
AWS Kinesis DescribeSignalingChannel API
AWS Kinesis DescribeStream API