{ "opencollection": "1.0.0", "info": { "name": "Amazon Kinesis Data Streams Account Consumers API", "version": "2013-12-02" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Consumers", "type": "folder" }, "items": [ { "info": { "name": "Amazon Kinesis Register a stream consumer for enhanced fan-out", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.RegisterStreamConsumer", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to." }, { "info": { "name": "Amazon Kinesis Deregister a stream consumer", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.DeregisterStreamConsumer", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To 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 it. You may also provide all three parameters, as long as they don't conflict with each other." }, { "info": { "name": "Amazon Kinesis Describe a stream consumer", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.DescribeStreamConsumer", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To get the description of a registered consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it." }, { "info": { "name": "Amazon Kinesis List stream consumers", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.ListStreamConsumers", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer." }, { "info": { "name": "Amazon Kinesis Subscribe to a shard for enhanced fan-out", "type": "http" }, "http": { "method": "POST", "url": "https://kinesis.{region}.amazonaws.com/#X-Amz-Target=Kinesis_20131202.SubscribeToShard", "headers": [ { "name": "X-Amz-Target", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation establishes an HTTP/2 connection between the consumer you specify in the ConsumerARN parameter and the shard you specify in the ShardId parameter. After the connection is successfully established, Kinesis Data Streams pushes records from the shard to the consumer over this connection. Before you call this operation, call RegisterStreamConsumer to register the consumer with the data stream. The connection persists for up to 5 minutes." } ] } ], "bundled": true }