{ "opencollection": "1.0.0", "info": { "name": "Amazon Kinesis Data Account Streams API", "version": "2013-12-02" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Streams", "type": "folder" }, "items": [ { "info": { "name": "Amazon Kinesis Create a Kinesis data stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.CreateStream", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Stream creation is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE." }, { "info": { "name": "Amazon Kinesis Delete a Kinesis data stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.DeleteStream", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes 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. Stream deletion is an asynchronous operation. After you delete a stream, data previously written to the stream is no longer accessible." }, { "info": { "name": "Amazon Kinesis Describe a Kinesis data stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.DescribeStream", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Describes the specified Kinesis data stream. The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. DescribeStream has a limit of 10 transactions per second per account." }, { "info": { "name": "Amazon Kinesis Get a summary description of a stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.DescribeStreamSummary", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provides a summarized description of the specified Kinesis data stream without the shard list. The information returned includes the stream name, Amazon Resource Name (ARN), status, stream mode, retention period, creation time, and encryption details." }, { "info": { "name": "Amazon Kinesis List Kinesis data streams", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.ListStreams", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists 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 streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 100." }, { "info": { "name": "Amazon Kinesis Update the capacity mode of a stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.UpdateStreamMode", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates 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 mode for your data streams." }, { "info": { "name": "Amazon Kinesis Increase the data retention period of a stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.IncreaseStreamRetentionPeriod", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Increases 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 value of a stream's retention period is 8760 hours (365 days)." }, { "info": { "name": "Amazon Kinesis Decrease the data retention period of a stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.DecreaseStreamRetentionPeriod", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Decreases 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 value of a stream's retention period is 24 hours." }, { "info": { "name": "Amazon Kinesis List Streams", "type": "http" }, "http": { "method": "GET", "url": "https://kinesis.{region}.amazonaws.com/streams" }, "docs": "Lists your Kinesis data streams." }, { "info": { "name": "Amazon Kinesis Create Stream", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/streams" }, "docs": "Creates a Kinesis data stream." }, { "info": { "name": "Amazon Kinesis Describe Stream Summary", "type": "http" }, "http": { "method": "GET", "url": "https://kinesis.{region}.amazonaws.com/streams/:StreamName/summary", "params": [ { "name": "StreamName", "value": "", "type": "path", "description": "The name of the stream." } ] }, "docs": "Provides a summarized description of the specified Kinesis data stream." }, { "info": { "name": "Amazon Kinesis Delete Stream", "type": "http" }, "http": { "method": "DELETE", "url": "https://kinesis.{region}.amazonaws.com/streams/:StreamName", "params": [ { "name": "StreamName", "value": "", "type": "path", "description": "The name of the stream." } ] }, "docs": "Deletes a Kinesis data stream and all its shards and data." }, { "info": { "name": "Amazon Kinesis Get Records", "type": "http" }, "http": { "method": "GET", "url": "https://kinesis.{region}.amazonaws.com/streams/:StreamName/records", "params": [ { "name": "StreamName", "value": "", "type": "path", "description": "The stream name." } ] }, "docs": "Gets data records from a Kinesis data stream shard." }, { "info": { "name": "Amazon Kinesis Put Record", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/streams/:StreamName/records", "params": [ { "name": "StreamName", "value": "", "type": "path", "description": "The stream name." } ] }, "docs": "Writes a single data record into an Amazon Kinesis data stream." }, { "info": { "name": "Amazon Kinesis Put Records", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/streams/:StreamName/records/batch", "params": [ { "name": "StreamName", "value": "", "type": "path", "description": "The stream name." } ] }, "docs": "Writes multiple data records into a Kinesis data stream in a single call." } ] } ], "bundled": true }