AsyncAPI channel · Amazon Kinesis
· Amazon Kinesis Data Streams
kinesis/{streamName}/{shardId}
A shard within a Kinesis data stream. Each shard is an append-only, ordered sequence of data records. Producers write records to shards via partition keys, and consumers read records sequentially. Each shard provides 1 MiB/sec write capacity and 2 MiB/sec read capacity (shared among polling consumers), or 2 MiB/sec dedicated throughput per enhanced fan-out consumer.
Provider:Amazon KinesisAsyncAPI: v3.0.0Spec: Amazon Kinesis Data StreamsOperations: 2Messages: 2
Channel address
kinesis/{streamName}/{shardId}
Parameters
streamName — The name of the Kinesis data stream. Must be between 1 and 128 characters, matching the pattern [a-zA-Z0-9_.-]+.
shardId — The unique identifier of the shard within the stream, for example shardId-000000000001.
Operations
send
publishRecord
A producer writes a data record to a Kinesis data stream shard. Each record includes a data blob (up to 1 MiB), a partition key, and optionally an explicit hash key. The partition key determines which
receive
consumeRecordsByPolling
A consumer polls for data records from a shard using GetRecords with a shard iterator obtained from GetShardIterator. Each call returns up to 10,000 records or 10 MiB.
Messages
KinesisRecord
A single data record in a Kinesis data stream. Each record contains a data blob, partition key, and is assigned a unique sequence number and approximate arrival timestamp by the service.
Content-Type: application/json
SubscribeToShardEvent
An event pushed to an enhanced fan-out consumer over an HTTP/2 connection. Contains a batch of data records along with a continuation sequence number and lag metrics.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.