ExAws.Kinesis v2.0.1 ExAws.Kinesis View Source
Operations on AWS Kinesis
http://docs.aws.amazon.com/kinesis/latest/APIReference/API_Operations.html
Link to this section 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
Link to this section Types
Link to this type
describe_stream_opts()
View Source
describe_stream_opts() :: [ limit: pos_integer(), exclusive_start_shard_id: binary() ]
Link to this type
get_shard_iterator_opts()
View Source
get_shard_iterator_opts() :: [{:starting_sequence_number, binary()}]
Link to this type
list_tags_for_stream_opts()
View Source
list_tags_for_stream_opts() :: [ limit: pos_integer(), exclusive_start_tag_key: binary() ]
Link to this type
shard_iterator_types()
View Source
shard_iterator_types() :: :at_sequence_number | :after_sequence_number | :trim_horizon | :latest
Link to this section Functions
Link to this function
add_tags_to_stream(stream_name, tags)
View Source
add_tags_to_stream(stream_name :: binary(), tags :: stream_tags()) :: ExAws.Operation.JSON.t()
Add tags to stream
Link to this function
create_stream(stream_name, shard_count \\ 1)
View Source
create_stream(stream_name :: stream_name(), shard_count :: pos_integer()) :: ExAws.Operation.JSON.t()
Creates stream
Link to this function
delete_stream(stream_name)
View Source
delete_stream(stream_name :: stream_name()) :: ExAws.Operation.JSON.t()
Deletes stream
Link to this function
describe_stream(stream_name, opts \\ [])
View Source
describe_stream(stream_name :: stream_name(), opts :: describe_stream_opts()) :: ExAws.Operation.JSON.t()
Describe Stream
Link to this function
get_records(shard_iterator, opts \\ [])
View Source
get_records(shard_iterator :: binary(), opts :: get_records_opts()) :: ExAws.Operation.JSON.t()
Get stream records
Link to this function
get_shard_iterator(stream_name, shard_id, shard_iterator_type, opts \\ [])
View Source
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
Lists streams
Link to this function
list_tags_for_stream(stream_name, opts \\ [])
View Source
list_tags_for_stream( stream_name :: binary(), opts :: list_tags_for_stream_opts() ) :: ExAws.Operation.JSON.t()
List tags for a stream
Link to this function
merge_shards(stream_name, adjacent_shard, shard)
View Source
merge_shards( stream_name :: stream_name(), adjacent_shard_id :: binary(), shard_id :: binary() ) :: ExAws.Operation.JSON.t()
Merge adjacent shards
Link to this function
put_record(stream_name, partition_key, data, opts \\ [])
View Source
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
Link to this function
put_records(stream_name, records)
View Source
put_records(stream_name :: stream_name(), records :: [put_records_record()]) :: ExAws.Operation.JSON.t()
Put multiple records on a stream
Link to this function
remove_tags_from_stream(stream_name, tag_keys)
View Source
remove_tags_from_stream(stream_name :: binary(), tag_keys :: [binary()]) :: ExAws.Operation.JSON.t()
Remove tags from stream
Link to this function
split_shard(stream_name, shard, new_starting_hash_key)
View Source
split_shard( stream_name :: binary(), shard :: binary(), new_starting_hash_key :: binary() ) :: ExAws.Operation.JSON.t()
Split a shard