Liking cljdoc? Tell your friends :D
ClojureScript only.

cljs-aws.kinesis

add-tags-to-streamcljs

(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_
sourceraw docstring

create-streamcljs

(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_
sourceraw docstring

decrease-stream-retention-periodcljs

(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_
sourceraw docstring

delete-streamcljs

(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_
sourceraw docstring

deregister-stream-consumercljs

(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
sourceraw docstring

describe-limitscljs

(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
sourceraw docstring

describe-streamcljs

(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_
sourceraw docstring

describe-stream-consumercljs

(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
sourceraw docstring

describe-stream-summarycljs

(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_
sourceraw docstring

disable-enhanced-monitoringcljs

(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_
sourceraw docstring

enable-enhanced-monitoringcljs

(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_
sourceraw docstring

get-recordscljs

(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_
sourceraw docstring

get-shard-iteratorcljs

(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_
sourceraw docstring

increase-stream-retention-periodcljs

(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_
sourceraw docstring

list-shardscljs

(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
sourceraw docstring

list-stream-consumerscljs

(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_
sourceraw docstring

list-streamscljs

(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
sourceraw docstring

list-tags-for-streamcljs

(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_
sourceraw docstring

merge-shardscljs

(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_
sourceraw docstring

put-recordcljs

(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_
sourceraw docstring

put-recordscljs

(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_
sourceraw docstring

register-stream-consumercljs

(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_
sourceraw docstring

remove-tags-from-streamcljs

(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_
sourceraw docstring

split-shardcljs

(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_
sourceraw docstring

start-stream-encryptioncljs

(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_
sourceraw docstring

stop-stream-encryptioncljs

(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_
sourceraw docstring

update-shard-countcljs

(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_
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
Raise an issueBrowse cljdoc sourceChat on Slack
× close