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

Operations for putting and getting data records to and from a stream.

Amazon Kinesis Records 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 Records. 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 4 operations across 4 paths, and defines 21 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.

4 operations 4 paths 21 schemas 4 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 Records 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 4

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

Records 4

Operations for putting and getting data records to and from a stream.

POST
/#X-Amz-Target=Kinesis_20131202.PutRecord
Amazon Kinesis Write a single data record to a stream
PutRecord 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.PutRecords
Amazon Kinesis Write multiple data records to a stream in a single call
PutRecords 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.GetShardIterator
Amazon Kinesis Get an iterator for reading records from a shard
GetShardIterator 1 param body → 200400404
POST
/#X-Amz-Target=Kinesis_20131202.GetRecords
Amazon Kinesis Get data records from a shard
GetRecords 1 param body → 200400404

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PutRecordInput (6 properties), GetShardIteratorInput (6 properties), Record (5 properties), PutRecordsResultEntry (4 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
2 properties
PutRecordInput
object
6 properties 2 required
PutRecordOutput
object
3 properties 2 required
GetRecordsInput
object
3 properties 1 required
PutRecordsResultEntry
object
Represents the result of an individual record in a PutRecords response.
4 properties
Record
object
The unit of data of the Kinesis data stream.
5 properties 3 required
ShardIteratorType
string
Determines how the shard iterator is used to start reading data records from the shard.
ShardId
string
The unique identifier of the shard within the stream.
SequenceNumber
string
The sequence number assigned to a data record. Sequence numbers increase over time within a shard.
GetShardIteratorOutput
object
1 property
StreamName
string
The name of the Kinesis data stream.
PartitionKey
string
Determines which shard in the stream the data record is assigned to. Unicode string with a maximum length of 256 characters.
PutRecordsInput
object
3 properties 1 required
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
PutRecordRequestEntry
object
Represents a record entry for a PutRecords request.
3 properties 2 required
GetRecordsOutput
object
4 properties 1 required
HashKeyRange
object
The range of possible hash key values for the shard.
2 properties 2 required
GetShardIteratorInput
object
6 properties 2 required
PutRecordsOutput
object
3 properties 1 required
StreamARN
string
The ARN of the Kinesis data stream.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-kinesis-records-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 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 Records 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.