Module erlcloud_kinesis

Data Types

exclusive_start_shard_id_opt()

exclusive_start_shard_id_opt() = {exclusive_start_shard_id, string()}

explicit_hash_key()

explicit_hash_key() = binary() | undefined

get_records_limit()

get_records_limit() = 1..10000

list_shards_opts()

list_shards_opts() = [exclusive_start_shard_id_opt() | max_results_opt() | next_token_opt() | stream_creation_timestamp_opt()]

max_results_opt()

max_results_opt() = {max_results, non_neg_integer()}

next_token_opt()

next_token_opt() = {next_token, string()}

ordering()

ordering() = binary() | undefined

partition_key()

partition_key() = binary()

payload()

payload() = binary() | string()

put_records_item()

put_records_item() = {Data::binary(), PartitionKey::binary()} | {Data::binary(), ExplicitHashKey::binary(), PartitionKey::binary()}

put_records_items()

put_records_items() = [put_records_item()]

stream_creation_timestamp_opt()

stream_creation_timestamp_opt() = {stream_creation_timestamp, integer()}

Function Index

add_tags_to_stream/2 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_AddTagsToStream.html
add_tags_to_stream/3
configure/2
configure/3
configure/4
create_stream/2 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html
create_stream/3
delete_stream/1 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html
delete_stream/2
describe_stream/1 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html
describe_stream/2
describe_stream/3
describe_stream/4
describe_stream_summary/1 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStreamSummary.html
describe_stream_summary/2
disable_enhanced_monitoring/1 Kinesis API: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DisableEnhancedMonitoring.html
disable_enhanced_monitoring/2
disable_enhanced_monitoring/3
enable_enhanced_monitoring/1 Kinesis API: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_EnableEnhancedMonitoring.html
enable_enhanced_monitoring/2
enable_enhanced_monitoring/3
get_records/1 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html
get_records/2
get_records/3
get_records/4
get_shard_iterator/3 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html
get_shard_iterator/4
get_shard_iterator/5
list_all_tags_for_stream/1 Wrapper around 'list_tags_for_stream' to return {ok, <list_of_all_tags>}.
list_all_tags_for_stream/2
list_shards/1 Kinesis API: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html
list_shards/2
list_shards/3
list_streams/0 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreams.html
list_streams/1
list_streams/2
list_streams/3
list_tags_for_stream/1 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListTagsForStream.html
list_tags_for_stream/2
list_tags_for_stream/3
list_tags_for_stream/4
merge_shards/3 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_MergeShards.html
merge_shards/4
new/2
new/3
put_record/3 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html
put_record/4
put_record/5
put_record/6
put_record/7
put_records/2
put_records/3
put_records/4
remove_tags_from_stream/2 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_RemoveTagsFromStream.html
remove_tags_from_stream/3
split_shards/3 Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_SplitShard.html
split_shards/4

Function Details

add_tags_to_stream/2

add_tags_to_stream(StreamName::binary(), Tags::[{binary(), binary()}, ...]) -> ok | {error, any()}

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_AddTagsToStream.html

Adds or updates tags for the specified Amazon Kinesis stream.

erlcloud_kinesis:add_tags_to_stream(<<"stream_name">>, [{<<"tag_key">>, <<"tag_value">>}]). ok.

add_tags_to_stream/3

add_tags_to_stream(StreamName::binary(), Tags::[{binary(), binary()}, ...], Config::aws_config()) -> ok | {error, any()}

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

configure/3

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok

configure/4

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> ok

create_stream/2

create_stream(StreamName::binary(), ShardCount::1..100000) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html

Example

This operation adds a new Amazon Kinesis stream to your AWS account.

erlcloud_kinesis:create_stream(&lt;&lt;"test"&gt;&gt;, 2). {ok,{incomplete,#Fun&lt;jsx_decoder.1.688044&gt;}}

create_stream/3

create_stream(StreamName::binary(), ShardCount::1..100000, Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

delete_stream/1

delete_stream(StreamName::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html

Example

This operation deletes a stream and all of its shards and data.

erlcloud_kinesis:delete_stream(&lt;&lt;"test"&gt;&gt;). {ok,{incomplete,#Fun&lt;jsx_decoder.1.688044&gt;}}

delete_stream/2

delete_stream(StreamName::binary(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

describe_stream/1

describe_stream(StreamName::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html

Example

This operation returns the following information about the stream: the current status of the stream, the stream Amazon Resource Name (ARN), and an array of shard objects that comprise the stream.

erlcloud_kinesis:describe_stream(&lt;&lt;"staging"&gt;&gt;). {ok,[{&lt;&lt;"StreamDescription"&gt;&gt;, [{&lt;&lt;"HasMoreShards"&gt;&gt;,false}, {&lt;&lt;"Shards"&gt;&gt;, [[{&lt;&lt;"HashKeyRange"&gt;&gt;, [{&lt;&lt;"EndingHashKey"&gt;&gt;, &lt;&lt;"170141183460469231731687303715884105727"&gt;&gt;}, {&lt;&lt;"StartingHashKey"&gt;&gt;,&lt;&lt;"0"&gt;&gt;}]}, {&lt;&lt;"SequenceNumberRange"&gt;&gt;, [{&lt;&lt;"StartingSequenceNumber"&gt;&gt;, &lt;&lt;"495372647485535624187345081927970814089871018992"...&gt;&gt;}]}, {&lt;&lt;"ShardId"&gt;&gt;,&lt;&lt;"shardId-000000000000"&gt;&gt;}], [{&lt;&lt;"HashKeyRange"&gt;&gt;, [{&lt;&lt;"EndingHashKey"&gt;&gt;, &lt;&lt;"340282366920938463463374607431768211455"&gt;&gt;}, {&lt;&lt;"StartingHashKey"&gt;&gt;, &lt;&lt;"170141183460469231731687303715884105728"&gt;&gt;}]}, {&lt;&lt;"SequenceNumberRange"&gt;&gt;, [{&lt;&lt;"StartingSequenceNumber"&gt;&gt;, &lt;&lt;"49537264748575863163933038815938617127259750"...&gt;&gt;}]}, {&lt;&lt;"ShardId"&gt;&gt;,&lt;&lt;"shardId-000000000001"&gt;&gt;}]]}, {&lt;&lt;"StreamARN"&gt;&gt;, &lt;&lt;"arn:aws:kinesis:us-east-1:821148768124:stream/staging"&gt;&gt;}, {&lt;&lt;"StreamName"&gt;&gt;,&lt;&lt;"staging"&gt;&gt;}, {&lt;&lt;"StreamStatus"&gt;&gt;,&lt;&lt;"ACTIVE"&gt;&gt;}]}]}

describe_stream/2

describe_stream(StreamName::binary(), Config::get_records_limit() | aws_config()) -> erlcloud_kinesis_impl:json_return()

describe_stream/3

describe_stream(StreamName::binary(), Limit::get_records_limit(), Config::string() | aws_config()) -> erlcloud_kinesis_impl:json_return()

describe_stream/4

describe_stream(StreamName::binary(), Limit::get_records_limit(), ExclusiveStartShardId::string(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

describe_stream_summary/1

describe_stream_summary(StreamName::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStreamSummary.html

Example

Provides a summarized description of the specified Kinesis data stream without the shard list.

erlcloud_kinesis:describe_stream_summary(&lt;&lt;"staging"&gt;&gt;). {ok,[{&lt;&lt;"StreamDescriptionSummary"&gt;&gt;, [{&lt;&lt;EncryptionType"&gt;&gt;,&lt;&lt;"NONE"&gt;&gt;}, {&lt;&lt;"EnhancedMonitoring"&gt;&gt;,[[{&lt;&lt;"ShardLevelMetrics"&gt;&gt;,[&lt;&lt;"ALL"&gt;&gt;]}]]}, {&lt;&lt;"KeyId"&gt;&gt;,&lt;&lt;"staging"&gt;&gt;}, {&lt;&lt;"OpenShardCount"&gt;&gt;,10}, {&lt;&lt;"RetentionPeriodHours"&gt;&gt;,24}, {&lt;&lt;"StreamARN"&gt;&gt;, &lt;&lt;"arn:aws:kinesis:us-east-1:821148768124:stream/staging"&gt;&gt;}, {&lt;&lt;"StreamName"&gt;&gt;,&lt;&lt;"staging"&gt;&gt;}, {&lt;&lt;"StreamStatus"&gt;&gt;,&lt;&lt;"ACTIVE"&gt;&gt;}]}]}

describe_stream_summary/2

describe_stream_summary(StreamName::binary(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

disable_enhanced_monitoring/1

disable_enhanced_monitoring(StreamName::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DisableEnhancedMonitoring.html

Example

Disables enhanced monitoring.

erlcloud_kinesis:disable_enhanced_monitoring(&lt;&lt;"staging"&gt;&gt;, [&lt;&lt;"ALL"&gt;&gt;]). {ok,[ {&lt;&lt;"CurrentShardLevelMetrics"&gt;&gt;,[{&lt;&lt;"ShardLevelMetrics"&gt;&gt;,[&lt;&lt;"ALL"&gt;&gt;]}]}, {&lt;&lt;"DesiredShardLevelMetrics"&gt;&gt;,[]}, {&lt;&lt;"StreamName"&gt;&gt;,&lt;&lt;"staging"&gt;&gt;} ]}

disable_enhanced_monitoring/2

disable_enhanced_monitoring(StreamName::binary(), Config::[binary()] | aws_config()) -> erlcloud_kinesis_impl:json_return()

disable_enhanced_monitoring/3

disable_enhanced_monitoring(StreamName::binary(), Metrics::[binary()], Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

enable_enhanced_monitoring/1

enable_enhanced_monitoring(StreamName::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_EnableEnhancedMonitoring.html

Example

nables enhanced Kinesis data stream monitoring for shard-level metrics.

erlcloud_kinesis:enable_enhanced_monitoring(&lt;&lt;"staging"&gt;&gt;, [&lt;&lt;"ALL"&gt;&gt;]). {ok,[ {&lt;&lt;"CurrentShardLevelMetrics"&gt;&gt;,[]}, {&lt;&lt;"DesiredShardLevelMetrics"&gt;&gt;,[{&lt;&lt;"ShardLevelMetrics"&gt;&gt;,[&lt;&lt;"ALL"&gt;&gt;]}]}, {&lt;&lt;"StreamName"&gt;&gt;,&lt;&lt;"staging"&gt;&gt;} ]}

enable_enhanced_monitoring/2

enable_enhanced_monitoring(StreamName::binary(), Config::[binary()] | aws_config()) -> erlcloud_kinesis_impl:json_return()

enable_enhanced_monitoring/3

enable_enhanced_monitoring(StreamName::binary(), Metrics::[binary()], Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

get_records/1

get_records(ShardIterator::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html

Example

This operation returns one or more data records from a shard. A GetRecords operation request can retrieve up to 10 MB of data.

{ok, [{_, A2}]} = erlcloud_kinesis:get_shard_terator(&lt;&lt;"test"&gt;&gt;, &lt;&lt;"shardId-000000000000"&gt;&gt;, &lt;&lt;"TRIM_HORIZON"&gt;&gt;). {ok,[{&lt;&lt;"ShardIterator"&gt;&gt;, &lt;&lt;"AAAAAAAAAAEuncwaAk+GTC2TIdmdg5w6dIuZ4Scu6vaMGPtaPUfopvw9cBm2NM3Rlj9WyI5JFJr2ahuSh3Z187AdW4Lug86E"...&gt;&gt;}]} erlcloud_kinesis:get_records(A2). {ok,[{&lt;&lt;"NextShardIterator"&gt;&gt;, &lt;&lt;"AAAAAAAAAAEkuCmrC+QDW1gUywyu7G8GxvRyM6GSMkcHQ9wrvCJBW87mjn9C8YEckkipaoJySwgKXMmn1BwSPjnjiUCsu6pc"...&gt;&gt;}, {&lt;&lt;"Records"&gt;&gt;, [[{&lt;&lt;"Data"&gt;&gt;,&lt;&lt;"asdasd"&gt;&gt;}, {&lt;&lt;"PartitionKey"&gt;&gt;,&lt;&lt;"key"&gt;&gt;}, {&lt;&lt;"SequenceNumber"&gt;&gt;, &lt;&lt;"49537292605574028653758531131893428543501381406818304001"&gt;&gt;}], [{&lt;&lt;"Data"&gt;&gt;,&lt;&lt;"asdasd 213123123"&gt;&gt;}, {&lt;&lt;"PartitionKey"&gt;&gt;,&lt;&lt;"key"&gt;&gt;}, {&lt;&lt;"SequenceNumber"&gt;&gt;, &lt;&lt;"49537292605574028653758541428570459745183078607853977601"&gt;&gt;}]]}]}

get_records/2

get_records(ShardIterator::binary(), Config::get_records_limit() | aws_config()) -> erlcloud_kinesis_impl:json_return()

get_records/3

get_records(ShardIterator::binary(), Limit::get_records_limit(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

get_records/4

get_records(ShardIterator::binary(), Limit::get_records_limit(), Options::proplist(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

get_shard_iterator/3

get_shard_iterator(StreamName::binary(), ShardId::binary(), ShardIteratorType::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html

Example

This operation returns a shard iterator in ShardIterator. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially.

erlcloud_kinesis:get_shard_iterator(&lt;&lt;"test"&gt;&gt;, &lt;&lt;"shardId-000000000001"&gt;&gt;, &lt;&lt;"TRIM_HORIZON"&gt;&gt;). {ok,[{&lt;&lt;"ShardIterator"&gt;&gt;, &lt;&lt;"AAAAAAAAAAFHJejL6/AjDShV3pIXsxYZT7Xj2G6EHxokHqT2D1stIOVYUEyprlUGWUepKqUDaR0+hB6qTlKvZa+fsBRqgHi4"...&gt;&gt;}]}

get_shard_iterator/4

get_shard_iterator(StreamName::binary(), ShardId::binary(), ShardIteratorType::binary(), Config::binary() | integer() | float() | aws_config()) -> erlcloud_kinesis_impl:json_return()

get_shard_iterator/5

get_shard_iterator(StreamName::binary(), ShardId::binary(), ShardIteratorType::binary(), Timestamp::binary() | integer() | float(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

list_all_tags_for_stream/1

list_all_tags_for_stream(StreamName::binary()) -> {ok, proplist()} | {error, any()}

Wrapper around 'list_tags_for_stream' to return {ok, <list_of_all_tags>}.

erlcloud_kinesis:list_all_tags_for_stream(<<"stream_name">>). {ok, [{<<"k1">>, <<"v1">>}, {<<"k2">>, <<"v2">>}] }.

list_all_tags_for_stream/2

list_all_tags_for_stream(StreamName::binary(), Config::aws_config()) -> {ok, proplist()} | {error, any()}

list_shards/1

list_shards(StreamNameOrOptions::binary() | list_shards_opts()) -> erlcloud_kinesis_impl:json_return() | {error, any()}

Kinesis API: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html

Example

This operation returns the following information about the stream: an array of shard objects that comprise the stream.

erlcloud_kinesis:list_shards(&lt;&lt;"staging"&gt;&gt;). {ok, [ {&lt;&lt;"NextToken"&gt;&gt;, &lt;&lt;"AAAAAAAAAAGK9EEG0sJqVhCUS2JsgigQ5dcpB4q9PYswrH2oK44Skbjtm+WR0xA7/hrAFFsohevH1/OyPnbzKBS1byPyCZuVcokYtQe/b1m4c0SCI7jctPT0oUTLRdwSRirKm9dp9YC/EL+kZHOvYAUnztVGsOAPEFC3ECf/bVC927bDZBbRRzy/44OHfWmrCLcbcWqehRh5D14WnL3yLsumhiHDkyuxSlkBepauvMnNLtTOlRtmQ5Q5reoujfq2gzeCSOtLcfXgBMztJqohPdgMzjTQSbwB9Am8rMpHLsDbSdMNXmITvw=="&gt;&gt;}, {&lt;&lt;"Shards"&gt;&gt;, [ [ {&lt;&lt;"ShardId"&gt;&gt;, &lt;&lt;"shardId-000000000001"&gt;&gt;}, {&lt;&lt;"HashKeyRange"&gt;&gt;, [ {&lt;&lt;"EndingHashKey"&gt;&gt;, &lt;&lt;"68056473384187692692674921486353642280"&gt;&gt;}, {&lt;&lt;"StartingHashKey"&gt;&gt;, &lt;&lt;"34028236692093846346337460743176821145"&gt;&gt;} ]}, {&lt;&lt;"SequenceNumberRange"&gt;&gt;, [ {&lt;&lt;"StartingSequenceNumber"&gt;&gt;, &lt;&lt;"49579844037727333356165064238440708846556371693205002258"&gt;&gt;} ]} ], [ {&lt;&lt;"ShardId"&gt;&gt;, &lt;&lt;"shardId-000000000002"&gt;&gt;}, {&lt;&lt;"HashKeyRange"&gt;&gt;, [ {&lt;&lt;"EndingHashKey"&gt;&gt;, &lt;&lt;"102084710076281539039012382229530463436"&gt;&gt;}, {&lt;&lt;"StartingHashKey"&gt;&gt;, &lt;&lt;"68056473384187692692674921486353642281"&gt;&gt;} ]}, {&lt;&lt;"SequenceNumberRange"&gt;&gt;, [ {&lt;&lt;"StartingSequenceNumber"&gt;&gt;, &lt;&lt;"49579844037749634101363594861582244564829020124710982690"&gt;&gt;} ]} ], [ {&lt;&lt;"ShardId"&gt;&gt;, &lt;&lt;"shardId-000000000003"&gt;&gt;}, {&lt;&lt;"HashKeyRange"&gt;&gt;, [ {&lt;&lt;"EndingHashKey"&gt;&gt;, &lt;&lt;"136112946768375385385349842972707284581"&gt;&gt;}, {&lt;&lt;"StartingHashKey"&gt;&gt;, &lt;&lt;"102084710022876281539039012382229530463437"&gt;&gt;} ]}, {&lt;&lt;"SequenceNumberRange"&gt;&gt;, [ {&lt;&lt;"StartingSequenceNumber"&gt;&gt;, &lt;&lt;"49579844037771934846562125484723780283101668556216963122"&gt;&gt;} ]} ] ]} ]}

list_shards/2

list_shards(StreamName::binary() | list_shards_opts(), Config::list_shards_opts() | aws_config()) -> erlcloud_kinesis_impl:json_return()

list_shards/3

list_shards(StreamName::binary(), Options::list_shards_opts(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

list_streams/0

list_streams() -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreams.html

Example

This operation returns an array of the names of all the streams that are associated with the AWS account making the ListStreams request.

erlcloud_kinesis:list_streams(). {ok,[{&lt;&lt;"HasMoreStreams"&gt;&gt;,false}, {&lt;&lt;"StreamNames"&gt;&gt;,[&lt;&lt;"staging"&gt;&gt;]}]}

list_streams/1

list_streams(Config::binary() | aws_config()) -> erlcloud_kinesis_impl:json_return()

list_streams/2

list_streams(ExclusiveStartStreamName::binary(), Config::1..100 | aws_config()) -> erlcloud_kinesis_impl:json_return()

list_streams/3

list_streams(ExclusiveStartStreamName::binary(), Limit::1..100, Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

list_tags_for_stream/1

list_tags_for_stream(StreamName::binary()) -> {ok, proplist()} | {error, any()}

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListTagsForStream.html

Lists the tags for the specified Amazon Kinesis stream.

erlcloud_kinesis:list_tags_for_stream(<<"stream_name">>, <<"key2">>, 2). {ok, [ {<<"HasMoreTags">>, true}, {<<"Tags">>, [[{<<"Key">>, <<"k1">>}, {<<"Value">>, <<"v1">>}], [{<<"Key">>, <<"k2">>}, {<<"Value">>, <<"v2">>}]]} ] }.

list_tags_for_stream/2

list_tags_for_stream(StreamName::binary(), Config::aws_config()) -> {ok, proplist()} | {error, any()}

list_tags_for_stream/3

list_tags_for_stream(StreamName::binary(), ESK::binary() | undefined, Limit::integer() | undefined) -> {ok, proplist()} | {error, any()}

list_tags_for_stream/4

list_tags_for_stream(StreamName::binary(), ESK::binary() | undefined, Limit::integer() | undefined, Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

merge_shards/3

merge_shards(StreamName::binary(), AdjacentShardToMerge::binary(), ShardToMerge::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_MergeShards.html

Example

This operation merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps.

erlcloud_kinesis:merge_shards(&lt;&lt;"test"&gt;&gt;, &lt;&lt;"shardId-000000000001"&gt;&gt;, &lt;&lt;"shardId-000000000003"&gt;&gt;). {ok,{incomplete,#Fun&lt;jsx_decoder.1.688044&gt;}}

merge_shards/4

merge_shards(StreamName::binary(), AdjacentShardToMerge::binary(), ShardToMerge::binary(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

new/2

new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()

new/3

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()

put_record/3

put_record(StreamName::binary(), PartitionKey::partition_key(), Data::payload()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html

Example

This operation puts a data record into an Amazon Kinesis stream from a producer.

erlcloud_kinesis:put_record(&lt;&lt;"test"&gt;&gt;, &lt;&lt;"key"&gt;&gt;, &lt;&lt;"asdasd"&gt;&gt;). {ok,[{&lt;&lt;"SequenceNumber"&gt;&gt;, &lt;&lt;"49537292605574028653758531131893428543501381406818304001"&gt;&gt;}, {&lt;&lt;"ShardId"&gt;&gt;,&lt;&lt;"shardId-000000000000"&gt;&gt;}]} erlcloud_kinesis:put_record(&lt;&lt;"test"&gt;&gt;, &lt;&lt;"key"&gt;&gt;, &lt;&lt;"asdasd 213123123"&gt;&gt;). {ok,[{&lt;&lt;"SequenceNumber"&gt;&gt;, &lt;&lt;"49537292605574028653758541428570459745183078607853977601"&gt;&gt;}, {&lt;&lt;"ShardId"&gt;&gt;,&lt;&lt;"shardId-000000000000"&gt;&gt;}]}

put_record/4

put_record(StreamName::binary(), PartitionKey::partition_key(), Data::payload(), Config::explicit_hash_key() | aws_config()) -> erlcloud_kinesis_impl:json_return()

put_record/5

put_record(StreamName::binary(), PartitionKey::partition_key(), Data::payload(), ExplicitHashKey::explicit_hash_key(), Config::ordering() | aws_config()) -> erlcloud_kinesis_impl:json_return()

put_record/6

put_record(StreamName::binary(), PartitionKey::partition_key(), Data::payload(), ExplicitHashKey::explicit_hash_key(), Ordering::ordering(), Config::proplist() | aws_config()) -> erlcloud_kinesis_impl:json_return()

put_record/7

put_record(StreamName::binary(), PartitionKey::partition_key(), Data::payload(), ExplicitHashKey::explicit_hash_key(), Ordering::ordering(), Options::proplist(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

put_records/2

put_records(StreamName::binary(), Items::put_records_items()) -> erlcloud_kinesis_impl:json_return()

put_records/3

put_records(StreamName::binary(), Items::put_records_items(), EncodingFun::function() | aws_config()) -> erlcloud_kinesis_impl:json_return()

put_records/4

put_records(StreamName::binary(), Items::put_records_items(), EncodingFun::function(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()

remove_tags_from_stream/2

remove_tags_from_stream(StreamName::binary(), TagKeys::[binary(), ...]) -> ok | {error, any()}

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_RemoveTagsFromStream.html

Removes tags from the specified Amazon Kinesis stream.

erlcloud_kinesis:remove_tags_from_stream(<<"stream_name">>, [<<"tag_key">>]). ok.

remove_tags_from_stream/3

remove_tags_from_stream(StreamName::binary(), TagKeys::[binary(), ...], Config::aws_config()) -> ok | {error, any()}

split_shards/3

split_shards(StreamName::binary(), ShardToSplit::binary(), NewStartingHashKey::binary()) -> erlcloud_kinesis_impl:json_return()

Kinesis API: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_SplitShard.html

Example

This operation splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data.

erlcloud_kinesis:split_shards(&lt;&lt;"test"&gt;&gt;, &lt;&lt;"shardId-000000000000"&gt;&gt;, &lt;&lt;"10"&gt;&gt;). {ok,{incomplete,#Fun&lt;jsx_decoder.1.688044&gt;}}

split_shards/4

split_shards(StreamName::binary(), ShardToSplit::binary(), NewStartingHashKey::binary(), Config::aws_config()) -> erlcloud_kinesis_impl:json_return()


Generated by EDoc