cljs-aws.kinesis

Liking cljdoc? Tell your friends :D

ClojureScript only.

add-tags-to-stream^cljs

(add-tags-to-stream params__1284__auto__)

Parameters :stream-name†, :tags†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#addTagsToStream-property

† required

__Parameters__
`:stream-name`†, `:tags`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#addTagsToStream-property

† _required_

source raw docstring

create-stream^cljs

(create-stream params__1284__auto__)

Parameters :shard-count†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#createStream-property

† required

__Parameters__
`:shard-count`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#createStream-property

† _required_

source raw docstring

decrease-stream-retention-period^cljs

(decrease-stream-retention-period params__1284__auto__)

Parameters :retention-period-hours†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#decreaseStreamRetentionPeriod-property

† required

__Parameters__
`:retention-period-hours`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#decreaseStreamRetentionPeriod-property

† _required_

source raw docstring

delete-stream^cljs

(delete-stream params__1284__auto__)

Parameters :enforce-consumer-deletion, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#deleteStream-property

† required

__Parameters__
`:enforce-consumer-deletion`, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#deleteStream-property

† _required_

source raw docstring

deregister-stream-consumer^cljs

(deregister-stream-consumer params__1284__auto__)

Parameters :consumer-arn, :consumer-name, :stream-arn

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#deregisterStreamConsumer-property

__Parameters__
`:consumer-arn`, `:consumer-name`, `:stream-arn`

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#deregisterStreamConsumer-property

source raw docstring

describe-limits^cljs

(describe-limits params__1284__auto__)

Parameters (none)

Returns :open-shard-count, :shard-limit

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeLimits-property

__Parameters__
(none)

__Returns__
`:open-shard-count`, `:shard-limit`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeLimits-property

source raw docstring

describe-stream^cljs

(describe-stream params__1284__auto__)

Parameters :exclusive-start-shard-id, :limit, :stream-name†

Returns :stream-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeStream-property

† required

__Parameters__
`:exclusive-start-shard-id`, `:limit`, `:stream-name`†

__Returns__
`:stream-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeStream-property

† _required_

source raw docstring

describe-stream-consumer^cljs

(describe-stream-consumer params__1284__auto__)

Parameters :consumer-arn, :consumer-name, :stream-arn

Returns :consumer-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeStreamConsumer-property

__Parameters__
`:consumer-arn`, `:consumer-name`, `:stream-arn`

__Returns__
`:consumer-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeStreamConsumer-property

source raw docstring

describe-stream-summary^cljs

(describe-stream-summary params__1284__auto__)

Parameters :stream-name†

Returns :stream-description-summary

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeStreamSummary-property

† required

__Parameters__
`:stream-name`†

__Returns__
`:stream-description-summary`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#describeStreamSummary-property

† _required_

source raw docstring

disable-enhanced-monitoring^cljs

(disable-enhanced-monitoring params__1284__auto__)

Parameters :shard-level-metrics†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#disableEnhancedMonitoring-property

† required

__Parameters__
`:shard-level-metrics`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#disableEnhancedMonitoring-property

† _required_

source raw docstring

enable-enhanced-monitoring^cljs

(enable-enhanced-monitoring params__1284__auto__)

Parameters :shard-level-metrics†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#enableEnhancedMonitoring-property

† required

__Parameters__
`:shard-level-metrics`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#enableEnhancedMonitoring-property

† _required_

source raw docstring

get-records^cljs

(get-records params__1284__auto__)

Parameters :limit, :shard-iterator†

Returns :millis-behind-latest, :next-shard-iterator, :records

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#getRecords-property

† required

__Parameters__
`:limit`, `:shard-iterator`†

__Returns__
`:millis-behind-latest`, `:next-shard-iterator`, `:records`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#getRecords-property

† _required_

source raw docstring

get-shard-iterator^cljs

(get-shard-iterator params__1284__auto__)

Parameters :shard-id†, :shard-iterator-type†, :starting-sequence-number, :stream-name†, :timestamp

Returns :shard-iterator

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#getShardIterator-property

† required

__Parameters__
`:shard-id`†, `:shard-iterator-type`†, `:starting-sequence-number`, `:stream-name`†, `:timestamp`

__Returns__
`:shard-iterator`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#getShardIterator-property

† _required_

source raw docstring

increase-stream-retention-period^cljs

(increase-stream-retention-period params__1284__auto__)

Parameters :retention-period-hours†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#increaseStreamRetentionPeriod-property

† required

__Parameters__
`:retention-period-hours`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#increaseStreamRetentionPeriod-property

† _required_

source raw docstring

list-shards^cljs

(list-shards params__1284__auto__)

Parameters :exclusive-start-shard-id, :max-results, :next-token, :stream-creation-timestamp, :stream-name

Returns :next-token, :shards

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listShards-property

__Parameters__
`:exclusive-start-shard-id`, `:max-results`, `:next-token`, `:stream-creation-timestamp`, `:stream-name`

__Returns__
`:next-token`, `:shards`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listShards-property

source raw docstring

list-stream-consumers^cljs

(list-stream-consumers params__1284__auto__)

Parameters :max-results, :next-token, :stream-arn†, :stream-creation-timestamp

Returns :consumers, :next-token

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listStreamConsumers-property

† required

__Parameters__
`:max-results`, `:next-token`, `:stream-arn`†, `:stream-creation-timestamp`

__Returns__
`:consumers`, `:next-token`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listStreamConsumers-property

† _required_

source raw docstring

list-streams^cljs

(list-streams params__1284__auto__)

Parameters :exclusive-start-stream-name, :limit

Returns :has-more-streams, :stream-names

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listStreams-property

__Parameters__
`:exclusive-start-stream-name`, `:limit`

__Returns__
`:has-more-streams`, `:stream-names`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listStreams-property

source raw docstring

(list-tags-for-stream params__1284__auto__)

Parameters :exclusive-start-tag-key, :limit, :stream-name†

Returns :has-more-tags, :tags

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listTagsForStream-property

† required

__Parameters__
`:exclusive-start-tag-key`, `:limit`, `:stream-name`†

__Returns__
`:has-more-tags`, `:tags`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#listTagsForStream-property

† _required_

source raw docstring

merge-shards^cljs

(merge-shards params__1284__auto__)

Parameters :adjacent-shard-to-merge†, :shard-to-merge†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#mergeShards-property

† required

__Parameters__
`:adjacent-shard-to-merge`†, `:shard-to-merge`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#mergeShards-property

† _required_

source raw docstring

put-record^cljs

(put-record params__1284__auto__)

Parameters :data†, :explicit-hash-key, :partition-key†, :sequence-number-for-ordering, :stream-name†

Returns :encryption-type, :sequence-number, :shard-id

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#putRecord-property

† required

__Parameters__
`:data`†, `:explicit-hash-key`, `:partition-key`†, `:sequence-number-for-ordering`, `:stream-name`†

__Returns__
`:encryption-type`, `:sequence-number`, `:shard-id`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#putRecord-property

† _required_

source raw docstring

put-records^cljs

(put-records params__1284__auto__)

Parameters :records†, :stream-name†

Returns :encryption-type, :failed-record-count, :records

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#putRecords-property

† required

__Parameters__
`:records`†, `:stream-name`†

__Returns__
`:encryption-type`, `:failed-record-count`, `:records`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#putRecords-property

† _required_

source raw docstring

register-stream-consumer^cljs

(register-stream-consumer params__1284__auto__)

Parameters :consumer-name†, :stream-arn†

Returns :consumer

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#registerStreamConsumer-property

† required

__Parameters__
`:consumer-name`†, `:stream-arn`†

__Returns__
`:consumer`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#registerStreamConsumer-property

† _required_

source raw docstring

remove-tags-from-stream^cljs

(remove-tags-from-stream params__1284__auto__)

Parameters :stream-name†, :tag-keys†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#removeTagsFromStream-property

† required

__Parameters__
`:stream-name`†, `:tag-keys`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#removeTagsFromStream-property

† _required_

source raw docstring

split-shard^cljs

(split-shard params__1284__auto__)

Parameters :new-starting-hash-key†, :shard-to-split†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#splitShard-property

† required

__Parameters__
`:new-starting-hash-key`†, `:shard-to-split`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#splitShard-property

† _required_

source raw docstring

start-stream-encryption^cljs

(start-stream-encryption params__1284__auto__)

Parameters :encryption-type†, :key-id†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#startStreamEncryption-property

† required

__Parameters__
`:encryption-type`†, `:key-id`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#startStreamEncryption-property

† _required_

source raw docstring

stop-stream-encryption^cljs

(stop-stream-encryption params__1284__auto__)

Parameters :encryption-type†, :key-id†, :stream-name†

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#stopStreamEncryption-property

† required

__Parameters__
`:encryption-type`†, `:key-id`†, `:stream-name`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#stopStreamEncryption-property

† _required_

source raw docstring

update-shard-count^cljs

(update-shard-count params__1284__auto__)

Parameters :scaling-type†, :stream-name†, :target-shard-count†

Returns :current-shard-count, :stream-name, :target-shard-count

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#updateShardCount-property

† required

__Parameters__
`:scaling-type`†, `:stream-name`†, `:target-shard-count`†

__Returns__
`:current-shard-count`, `:stream-name`, `:target-shard-count`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#updateShardCount-property

† _required_

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close

cljs-aws.kinesis

add-tags-to-streamcljs

create-streamcljs

decrease-stream-retention-periodcljs

delete-streamcljs

deregister-stream-consumercljs

describe-limitscljs

describe-streamcljs

describe-stream-consumercljs

describe-stream-summarycljs

disable-enhanced-monitoringcljs

enable-enhanced-monitoringcljs

get-recordscljs

get-shard-iteratorcljs

increase-stream-retention-periodcljs

list-shardscljs

list-stream-consumerscljs

list-streamscljs

list-tags-for-streamcljs

merge-shardscljs

put-recordcljs

put-recordscljs

register-stream-consumercljs

remove-tags-from-streamcljs

split-shardcljs

start-stream-encryptioncljs

stop-stream-encryptioncljs

update-shard-countcljs

add-tags-to-stream^cljs

create-stream^cljs

decrease-stream-retention-period^cljs

delete-stream^cljs

deregister-stream-consumer^cljs

describe-limits^cljs

describe-stream^cljs

describe-stream-consumer^cljs

describe-stream-summary^cljs

disable-enhanced-monitoring^cljs

enable-enhanced-monitoring^cljs

get-records^cljs

get-shard-iterator^cljs

increase-stream-retention-period^cljs

list-shards^cljs

list-stream-consumers^cljs

list-streams^cljs

list-tags-for-stream^cljs

merge-shards^cljs

put-record^cljs

put-records^cljs

register-stream-consumer^cljs

remove-tags-from-stream^cljs

split-shard^cljs

start-stream-encryption^cljs

stop-stream-encryption^cljs

update-shard-count^cljs