Amazon Kinesis
Amazon Kinesis Data Streams Service API Reference Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of…
Data & analytics#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Kinesis Data Streams Service API Reference
Amazon Kinesis Data Streams is a managed service that scales elastically for real-time
processing of streaming big data.
Endpoints 45
- POSTAdd tags to stream
/#X-Amz-Target=Kinesis_20131202.AddTagsToStreamAdds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream. When invoking this API, you must use either the… - POSTCreate channel
/#X-Amz-Target=Kinesis_20131202.CreateChannelCreates a channel that delivers records from a Kinesis data stream to a destination. A channel reads records from the specified stream and writes them to… - POSTCreate stream
/#X-Amz-Target=Kinesis_20131202.CreateStreamCreates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers .… - POSTDecrease stream retention period
/#X-Amz-Target=Kinesis_20131202.DecreaseStreamRetentionPeriodDecreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum… - POSTDelete channel
/#X-Amz-Target=Kinesis_20131202.DeleteChannelDeletes the specified channel. Deleting a channel stops delivery from the source stream to the destination. Data already delivered to the destination is not… - POSTDelete resource policy
/#X-Amz-Target=Kinesis_20131202.DeleteResourcePolicyDelete a policy for the specified data stream or consumer. Request patterns can be one of the following: Data stream pattern:… - POSTDelete stream
/#X-Amz-Target=Kinesis_20131202.DeleteStreamDeletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream.… - POSTDeregister stream consumer
/#X-Amz-Target=Kinesis_20131202.DeregisterStreamConsumerTo deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered… - POSTDescribe account settings
/#X-Amz-Target=Kinesis_20131202.DescribeAccountSettingsDescribes the account-level settings for Amazon Kinesis Data Streams. This operation returns information about the minimum throughput billing commitments and… - POSTDescribe channel
/#X-Amz-Target=Kinesis_20131202.DescribeChannelDescribes the specified channel, including its configuration and current status. Use this operation to verify that a channel reached the ACTIVE state after… - POSTDescribe limits
/#X-Amz-Target=Kinesis_20131202.DescribeLimitsDescribes the shard limits and usage for the account. If you update your account limits, the old limits might be returned for a few minutes. This operation… - POSTDescribe stream
/#X-Amz-Target=Kinesis_20131202.DescribeStreamDescribes the specified Kinesis data stream. This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized… - POSTDescribe stream consumer
/#X-Amz-Target=Kinesis_20131202.DescribeStreamConsumerTo get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you… - POSTDescribe stream summary
/#X-Amz-Target=Kinesis_20131202.DescribeStreamSummaryProvides a summarized description of the specified Kinesis data stream without the shard list. When invoking this API, you must use either the StreamARN or… - POSTDisable enhanced monitoring
/#X-Amz-Target=Kinesis_20131202.DisableEnhancedMonitoringDisables enhanced monitoring. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use… - POSTEnable enhanced monitoring
/#X-Amz-Target=Kinesis_20131202.EnableEnhancedMonitoringEnables enhanced Kinesis data stream monitoring for shard-level metrics. When invoking this API, you must use either the StreamARN or the StreamName… - POSTGet records
/#X-Amz-Target=Kinesis_20131202.GetRecordsGets data records from a Kinesis data stream's shard. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is… - POSTGet resource policy
/#X-Amz-Target=Kinesis_20131202.GetResourcePolicyReturns a policy attached to the specified data stream or consumer. Request patterns can be one of the following: Data stream pattern:… - POSTGet shard iterator
/#X-Amz-Target=Kinesis_20131202.GetShardIteratorGets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester. When invoking this API, you must use either… - POSTIncrease stream retention period
/#X-Amz-Target=Kinesis_20131202.IncreaseStreamRetentionPeriodIncreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum… - POSTList channels
/#X-Amz-Target=Kinesis_20131202.ListChannelsLists the channels in your account. You can filter the results by source stream. The results are paginated. Use the NextToken value returned in the response… - POSTList shards
/#X-Amz-Target=Kinesis_20131202.ListShardsLists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream. When… - POSTList stream consumers
/#X-Amz-Target=Kinesis_20131202.ListStreamConsumersLists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer. This operation has a limit… - POSTList streams
/#X-Amz-Target=Kinesis_20131202.ListStreamsLists your Kinesis data streams. The number of streams may be too large to return from a single call to ListStreams . You can limit the number of returned… - POSTList tags for resource
/#X-Amz-Target=Kinesis_20131202.ListTagsForResourceList all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify,… - POSTList tags for stream
/#X-Amz-Target=Kinesis_20131202.ListTagsForStreamLists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. When invoking this API, you must… - POSTMerge shards
/#X-Amz-Target=Kinesis_20131202.MergeShardsMerges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. This… - POSTPut record
/#X-Amz-Target=Kinesis_20131202.PutRecordWrites a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing,… - POSTPut records
/#X-Amz-Target=Kinesis_20131202.PutRecordsWrites multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the… - POSTPut resource policy
/#X-Amz-Target=Kinesis_20131202.PutResourcePolicyAttaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of the Amazon Web Services… - POSTRegister stream consumer
/#X-Amz-Target=Kinesis_20131202.RegisterStreamConsumerRegisters a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from… - POSTRemove tags from stream
/#X-Amz-Target=Kinesis_20131202.RemoveTagsFromStreamRemoves tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes. When… - POSTSplit shard
/#X-Amz-Target=Kinesis_20131202.SplitShardSplits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there… - POSTStart stream encryption
/#X-Amz-Target=Kinesis_20131202.StartStreamEncryptionEnables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream. When invoking this API, you must use either the… - POSTStop stream encryption
/#X-Amz-Target=Kinesis_20131202.StopStreamEncryptionDisables server-side encryption for a specified stream. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is… - POSTSubscribe to shard
/#X-Amz-Target=Kinesis_20131202.SubscribeToShardThis operation establishes an HTTP/2 connection between the consumer you specify in the ConsumerARN parameter and the shard you specify in the ShardId… - POSTTag resource
/#X-Amz-Target=Kinesis_20131202.TagResourceAdds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify,… - POSTUntag resource
/#X-Amz-Target=Kinesis_20131202.UntagResourceRemoves tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully. - POSTUpdate account settings
/#X-Amz-Target=Kinesis_20131202.UpdateAccountSettingsUpdates the account-level settings for Amazon Kinesis Data Streams. Updating account settings is a synchronous operation. Upon receiving the request, Kinesis… - POSTUpdate channel
/#X-Amz-Target=Kinesis_20131202.UpdateChannelUpdates the data freshness interval or the Amazon CloudWatch Logs configuration of an existing channel. You cannot change the destination, source stream,… - POSTUpdate max record size
/#X-Amz-Target=Kinesis_20131202.UpdateMaxRecordSizeThis allows you to update the MaxRecordSize of a single record that you can write to, and read from a stream. You can ingest and digest single records up to… - POSTUpdate shard count
/#X-Amz-Target=Kinesis_20131202.UpdateShardCountUpdates the shard count of the specified stream to the specified number of shards. This API is only supported for the data streams with the provisioned… - POSTUpdate stream mode
/#X-Amz-Target=Kinesis_20131202.UpdateStreamModeUpdates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity… - POSTUpdate stream record distribution strategy
/#X-Amz-Target=Kinesis_20131202.UpdateStreamRecordDistributionStrategyUpdates the record distribution strategy for the specified Amazon Kinesis Data Streams on-demand data stream. The record distribution strategy determines how… - POSTUpdate stream warm throughput
/#X-Amz-Target=Kinesis_20131202.UpdateStreamWarmThroughputUpdates the warm throughput configuration for the specified Amazon Kinesis Data Streams on-demand data stream. Updates the warm throughput configuration for…
API details
- Base URL
https://kinesis.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 45 operations on 45 pathsPOST 45
- Description format
- AWS Smithy model, API version
2013-12-02 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Kinesis in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Kinesis collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add tags to stream” (POST /#X-Amz-Target=Kinesis_20131202.AddTagsToStream), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Kinesis?
Amazon Kinesis Data Streams Service API Reference Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of… It is listed under Data & analytics and has 45 endpoints.
Who publishes the Amazon Kinesis?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Kinesis?
Requests go to https://kinesis.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Kinesis?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Kinesis have?
45 operations on 45 paths (45 POST).
Is forking the Amazon Kinesis free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.