AWS Kinesis Amazon Kinesis API is one of 32 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Amazon Kinesis. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.
This API exposes
28 operations
across 28 paths,
and defines 127 schemas.
It is described by OpenAPI 3.2.0, at version 2013-12-02.
Requests are made against 4 base URLs: http://kinesis.{region}.amazonaws.com, https://kinesis.{region}.amazonaws.com, http://kinesis.{region}.amazonaws.com.cn, https://kinesis.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
PutRecordsResultEntry
object
Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in…
4 properties
ListTagsForStreamInput
object
Represents the input for ListTagsForStream .
4 properties
ListTagsForStreamInputLimit
integer
Tag
object
Metadata assigned to the stream, consisting of a key-value pair.
2 properties
1 required
EnableEnhancedMonitoringInput
object
Represents the input for EnableEnhancedMonitoring .
3 properties
1 required
ListShardsOutput
object
2 properties
GetShardIteratorOutput
object
Represents the output for GetShardIterator .
1 property
ShardFilter
object
The request parameter used to filter out the response of the ListShards API.
3 properties
1 required
PutRecordOutput
object
Represents the output for PutRecord .
3 properties
2 required
RegisterStreamConsumerInput
object
2 properties
2 required
DescribeStreamSummaryInput
object
2 properties
ListStreamConsumersInputLimit
integer
DescribeLimitsOutput
object
4 properties
4 required
EnhancedMetrics
object
Represents enhanced metrics types.
1 property
Consumer
object
An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer .
4 properties
4 required
ListShardsInputLimit
integer
ListStreamConsumersOutput
object
2 properties
PutRecordsRequestEntry
object
Represents the output for PutRecords .
3 properties
2 required
StartStreamEncryptionInput
object
4 properties
2 required
SequenceNumberRange
object
The range of possible sequence numbers for the shard.
2 properties
1 required
StreamDescriptionSummary
object
Represents the output for DescribeStreamSummary
11 properties
7 required
Record
object
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
5 properties
3 required
RemoveTagsFromStreamInput
object
Represents the input for RemoveTagsFromStream .
3 properties
1 required
DeregisterStreamConsumerInput
object
3 properties
PutRecordsResultEntryList
array
ExpiredNextTokenException
DescribeStreamInput
object
Represents the input for DescribeStream .
4 properties
SplitShardInput
object
Represents the input for SplitShard .
4 properties
2 required
GetRecordsInput
object
Represents the input for GetRecords .
3 properties
1 required
UpdateShardCountInput
object
4 properties
2 required
ListStreamsInput
object
Represents the input for ListStreams .
3 properties
ConsumerCountObject
integer
CreateStreamInput
object
Represents the input for CreateStream .
3 properties
1 required
StreamSummary
object
The summary of a stream.
5 properties
3 required
ConsumerDescription
object
An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer .
5 properties
5 required
GetRecordsInputLimit
integer
StreamDescription
object
Represents the output for DescribeStream .
11 properties
8 required
EnhancedMonitoringOutput
object
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring .
4 properties
UpdateShardCountOutput
object
4 properties
DescribeStreamOutput
object
Represents the output for DescribeStream .
1 property
1 required
ProvisionedThroughputExceededException
RegisterStreamConsumerOutput
object
1 property
1 required
MergeShardsInput
object
Represents the input for MergeShards .
4 properties
2 required
DescribeStreamConsumerInput
object
3 properties
DecreaseStreamRetentionPeriodInput
object
Represents the input for DecreaseStreamRetentionPeriod .
3 properties
1 required
PutRecordsOutput
object
PutRecords results.
3 properties
1 required
DeleteStreamInput
object
Represents the input for DeleteStream .
3 properties
GetShardIteratorInput
object
Represents the input for GetShardIterator .
6 properties
2 required
ListTagsForStreamOutput
object
Represents the output for ListTagsForStream .
2 properties
2 required
MillisBehindLatest
integer
DescribeStreamConsumerOutput
object
1 property
1 required
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
OnDemandStreamCountObject
integer
PutRecordInput
object
Represents the input for PutRecord .
6 properties
2 required
ListStreamConsumersInput
object
4 properties
1 required
StopStreamEncryptionInput
object
4 properties
2 required
DescribeStreamSummaryOutput
object
1 property
1 required
Shard
object
A uniquely identified group of data records in a Kinesis data stream.
5 properties
3 required
ResourceNotFoundException
PutRecordsInput
object
A PutRecords request.
3 properties
1 required
ChildShard
object
Output parameter of the GetRecords API. The existing child shard of the current shard.
3 properties
3 required
ListStreamsInputLimit
integer
RetentionPeriodHours
integer
PositiveIntegerObject
integer
IncreaseStreamRetentionPeriodInput
object
Represents the input for IncreaseStreamRetentionPeriod .
3 properties
1 required
UpdateStreamModeInput
object
2 properties
2 required
AddTagsToStreamInput
object
Represents the input for AddTagsToStream .
3 properties
1 required
EnhancedMonitoringList
array
OnDemandStreamCountLimitObject
integer
GetRecordsOutput
object
Represents the output for GetRecords .
4 properties
1 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
ListShardsInput
object
7 properties
DescribeStreamInputLimit
integer
DisableEnhancedMonitoringInput
object
Represents the input for DisableEnhancedMonitoring .
3 properties
1 required
PutRecordsRequestEntryList
array
DescribeLimitsInput
object
ListStreamsOutput
object
Represents the output for ListStreams .
4 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AWS Kinesis publishes across the network.
