How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Kinesis Streams API

Operations for creating, describing, listing, and managing Kinesis data streams.

Amazon Kinesis Streams API is one of 11 APIs that Amazon Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Streams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, pricing, a getting-started guide, and 2 JSON Schemas.

This API exposes 15 operations across 13 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://kinesis.{region}.amazonaws.com, https://kinesis.us-east-1.amazonaws.com.

15 operations 13 paths 27 schemas 1 DELETE3 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://kinesis.amazonaws.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Amazon Kinesis Streams API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (aws_sigv4). An API key is passed in the header as Authorization (sigv4).

  • aws_sigv4 — AWS Signature Version 4 authentication. Requests must be signed with the access key ID and secret access key of an IAM principal.
  • sigv4 — AWS Signature Version 4 authentication

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 3 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Streams 15

Operations for creating, describing, listing, and managing Kinesis data streams.

POST
/#X-Amz-Target=Kinesis_20131202.CreateStream
Amazon Kinesis Create a Kinesis data stream
CreateStream 1 param body → 200400409
POST
/#X-Amz-Target=Kinesis_20131202.DeleteStream
Amazon Kinesis Delete a Kinesis data stream
DeleteStream 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.DescribeStream
Amazon Kinesis Describe a Kinesis data stream
DescribeStream 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.DescribeStreamSummary
Amazon Kinesis Get a summary description of a stream
DescribeStreamSummary 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.ListStreams
Amazon Kinesis List Kinesis data streams
ListStreams 1 param body → 200400
POST
/#X-Amz-Target=Kinesis_20131202.UpdateStreamMode
Amazon Kinesis Update the capacity mode of a stream
UpdateStreamMode 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.IncreaseStreamRetentionPeriod
Amazon Kinesis Increase the data retention period of a stream
IncreaseStreamRetentionPeriod 1 param body → 200400
POST
/#X-Amz-Target=Kinesis_20131202.DecreaseStreamRetentionPeriod
Amazon Kinesis Decrease the data retention period of a stream
DecreaseStreamRetentionPeriod 1 param body → 200400
POST
/streams
Amazon Kinesis Create Stream
CreateStream → 200400403500
GET
/streams
Amazon Kinesis List Streams
ListStreams → 200400403500
GET
/streams/{StreamName}/summary
Amazon Kinesis Describe Stream Summary
DescribeStreamSummary 1 param → 200400403500
DELETE
/streams/{StreamName}
Amazon Kinesis Delete Stream
DeleteStream 1 param → 200400403500
POST
/streams/{StreamName}/records
Amazon Kinesis Put Record
PutRecord 1 param → 200400403500
GET
/streams/{StreamName}/records
Amazon Kinesis Get Records
GetRecords 1 param → 200400403500
POST
/streams/{StreamName}/records/batch
Amazon Kinesis Put Records
PutRecords 1 param → 200400403500

Schemas 27

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

ErrorResponse
object
2 properties
CreateStreamInput
object
4 properties 1 required
SequenceNumberRange
object
The range of possible sequence numbers for the shard.
2 properties 1 required
ListStreamsOutput
object
4 properties 2 required
StreamModeDetails
object
The capacity mode details for the data stream.
1 property 1 required
DescribeStreamInput
object
4 properties
DescribeStreamSummaryInput
object
2 properties
StreamDescriptionSummary
object
Summary information about a Kinesis data stream.
11 properties 7 required
StreamStatus
string
The current status of the data stream.
DescribeStreamOutput
object
1 property 1 required
EnhancedMetrics
object
Enhanced shard-level metric details.
1 property
DeleteStreamInput
object
3 properties
SequenceNumber
string
The sequence number assigned to a data record. Sequence numbers increase over time within a shard.
ShardId
string
The unique identifier of the shard within the stream.
IncreaseStreamRetentionPeriodInput
object
3 properties 1 required
UpdateStreamModeInput
object
2 properties 2 required
StreamName
string
The name of the Kinesis data stream.
ListStreamsInput
object
3 properties
DescribeStreamSummaryOutput
object
1 property 1 required
EncryptionType
string
The encryption type used on the record or stream.
StreamMode
string
Specifies the capacity mode to which you want to set your data stream. PROVISIONED requires you to set ShardCount; ONDEMAND automatically manages the number of…
StreamDescription
object
Detailed information about a Kinesis data stream.
11 properties 8 required
DecreaseStreamRetentionPeriodInput
object
3 properties 1 required
HashKeyRange
object
The range of possible hash key values for the shard.
2 properties 2 required
StreamARN
string
The ARN of the Kinesis data stream.
MetricsName
string
The name of the shard-level metric.
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

amazon-kinesis-streams-api-openapi.yml Raw ↑

Other APIs Amazon Kinesis publishes across the network.

Amazon Kinesis Account API
Amazon Kinesis Consumers API
Amazon Kinesis Encryption API
Amazon Kinesis Monitoring API
Amazon Kinesis Policies API
Amazon Kinesis Records API
Amazon Kinesis Shards API
Amazon Kinesis #X Amz Target=Kinesis 20131202.AddTagsToStream API
Amazon Kinesis #X Amz Target=Kinesis 20131202.ListTagsForStream API
Amazon Kinesis #X Amz Target=Kinesis 20131202.RemoveTagsFromStream API
Where this information came from

This is an independent, third-party profile of Amazon Kinesis Streams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.