ExAws v1.0.0-beta2 ExAws.Kinesis
Operations on AWS Kinesis
http://docs.aws.amazon.com/kinesis/latest/APIReference/API_Operations.html
Summary
Functions
Add tags to stream
Creates stream
Deletes stream
Describe Stream
Get stream records
Get a shard iterator
Lists streams
List tags for a stream
Merge adjacent shards
Puts a record on a stream
Put multiple records on a stream
Remove tags from stream
Split a shard
Types
describe_stream_opts :: [limit: pos_integer, exclusive_start_shard_id: binary]
get_records_opts :: [{:limit, pos_integer}]
get_shard_iterator_opts :: [{:starting_sequence_number, binary}]
put_record_opts :: [explicit_hash_key: binary, sequence_number_for_ordering: binary]
put_records_record :: [data: binary, explicit_hash_key: binary]
shard_iterator_types ::
:at_sequence_number |
:after_sequence_number |
:trim_horizon |
:latest
stream_name :: binary
Functions
Specs
add_tags_to_stream(stream_name :: binary, tags :: stream_tags) :: ExAws.Operation.JSON.t
Add tags to stream
Specs
create_stream(stream_name :: stream_name, shard_count :: pos_integer) :: ExAws.Operation.JSON.t
Creates stream
Specs
delete_stream(stream_name :: stream_name) :: ExAws.Operation.JSON.t
Deletes stream
Specs
describe_stream(stream_name :: stream_name, opts :: describe_stream_opts) :: ExAws.Operation.JSON.t
Describe Stream
Specs
get_records(shard_iterator :: binary, opts :: get_records_opts) :: ExAws.Operation.JSON.t
Get stream records
Specs
get_shard_iterator(stream_name :: stream_name, shard_id :: binary, shard_iterator_type :: shard_iterator_types, opts :: get_shard_iterator_opts) :: ExAws.Operation.JSON.t
Get a shard iterator
Specs
list_tags_for_stream(stream_name :: binary, opts :: list_tags_for_stream_opts) :: ExAws.Operation.JSON.t
List tags for a stream
Specs
merge_shards(stream_name :: stream_name, adjacent_shard_id :: binary, shard_id :: binary) :: ExAws.Operation.JSON.t
Merge adjacent shards
Specs
put_record(stream_name :: stream_name, partition_key :: binary, data :: binary, opts :: put_record_opts) :: ExAws.Operation.JSON.t
Puts a record on a stream
Specs
put_records(stream_name :: stream_name, records :: [put_records_record]) :: ExAws.Operation.JSON.t
Put multiple records on a stream
Specs
remove_tags_from_stream(stream_name :: binary, tag_keys :: [binary]) :: ExAws.Operation.JSON.t
Remove tags from stream
Specs
split_shard(stream_name :: binary, shard :: binary, new_starting_hash_key :: binary) :: ExAws.Operation.JSON.t
Split a shard