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 Consumers API

Operations for registering, describing, listing, and deregistering enhanced fan-out consumers.

Amazon Kinesis Consumers 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 Consumers. 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 5 operations across 5 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 2013-12-02.

Requests are made against a single base URL, https://kinesis.{region}.amazonaws.com.

5 operations 5 paths 25 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2013-12-02
Base URL
https://kinesis.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Amazon Kinesis Consumers API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_sigv4). By default, every request must be authenticated.

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

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Consumers 5

Operations for registering, describing, listing, and deregistering enhanced fan-out consumers.

POST
/#X-Amz-Target=Kinesis_20131202.RegisterStreamConsumer
Amazon Kinesis Register a stream consumer for enhanced fan-out
RegisterStreamConsumer 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.DeregisterStreamConsumer
Amazon Kinesis Deregister a stream consumer
DeregisterStreamConsumer 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.DescribeStreamConsumer
Amazon Kinesis Describe a stream consumer
DescribeStreamConsumer 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.ListStreamConsumers
Amazon Kinesis List stream consumers
ListStreamConsumers 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.SubscribeToShard
Amazon Kinesis Subscribe to a shard for enhanced fan-out
SubscribeToShard 1 param body → 200400404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Record (5 properties), ConsumerDescription (5 properties), Consumer (4 properties), ListStreamConsumersInput (4 properties). Each schema is shown below with its type and property counts.

DescribeStreamConsumerOutput
object
1 property 1 required
ErrorResponse
object
2 properties
StartingPosition
object
The starting position in the data stream from which to start streaming.
3 properties 1 required
ListStreamConsumersInput
object
4 properties 1 required
RegisterStreamConsumerInput
object
2 properties 2 required
RegisterStreamConsumerOutput
object
1 property 1 required
Consumer
object
An object that represents the details of the consumer you registered.
4 properties 4 required
ConsumerDescription
object
Full description of a registered stream consumer.
5 properties 5 required
Record
object
The unit of data of the Kinesis data stream.
5 properties 3 required
DeregisterStreamConsumerInput
object
3 properties
DescribeStreamConsumerInput
object
3 properties
ShardIteratorType
string
Determines how the shard iterator is used to start reading data records from the shard.
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.
SubscribeToShardEvent
object
An event pushed over the HTTP/2 connection to the consumer. Contains the data records from the shard along with metadata.
4 properties 3 required
SubscribeToShardOutput
object
1 property 1 required
ConsumerStatus
string
The current status of the registered stream consumer.
ListStreamConsumersOutput
object
2 properties
PartitionKey
string
Determines which shard in the stream the data record is assigned to. Unicode string with a maximum length of 256 characters.
EncryptionType
string
The encryption type used on the record or stream.
ChildShard
object
A child shard resulting from a shard split or merge.
3 properties 3 required
SubscribeToShardInput
object
3 properties 3 required
HashKeyRange
object
The range of possible hash key values for the shard.
2 properties 2 required
ConsumerARN
string
The ARN of the registered stream consumer.
StreamARN
string
The ARN of the Kinesis data stream.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Amazon Kinesis publishes across the network.

Amazon Kinesis Account API
Amazon Kinesis Encryption API
Amazon Kinesis Monitoring API
Amazon Kinesis Policies API
Amazon Kinesis Records API
Amazon Kinesis Shards API
Amazon Kinesis Streams 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 Consumers 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.