ExAws v1.1.1 ExAws.Kinesis

Operations on AWS Kinesis

http://docs.aws.amazon.com/kinesis/latest/APIReference/API_Operations.html

Summary

Types

describe_stream_opts()

get_records_opts()

get_shard_iterator_opts()

list_tags_for_stream_opts()

put_record_opts()

put_records_record()

shard_iterator_types()

Functions

add_tags_to_stream(stream_name, tags)

Add tags to stream

create_stream(stream_name, shard_count \\ 1)

Creates stream

decode_records(result)

delete_stream(stream_name)

Deletes stream

describe_stream(stream_name, opts \\ [])

Describe Stream

get_records(shard_iterator, opts \\ [])

Get stream records

get_shard_iterator(stream_name, shard_id, shard_iterator_type, opts \\ [])

Get a shard iterator

Lists streams

list_tags_for_stream(stream_name, opts \\ [])

List tags for a stream

merge_shards(stream_name, adjacent_shard, shard)

Merge adjacent shards

put_record(stream_name, partition_key, data, opts \\ [])

Puts a record on a stream

put_records(stream_name, records)

Put multiple records on a stream

remove_tags_from_stream(stream_name, tag_keys)

Remove tags from stream

split_shard(stream_name, shard, new_starting_hash_key)

Split a shard

Types

describe_stream_opts()

describe_stream_opts() :: [limit: pos_integer, exclusive_start_shard_id: binary]

get_records_opts()

get_records_opts() :: [{:limit, pos_integer}]

get_shard_iterator_opts()

get_shard_iterator_opts() :: [{:starting_sequence_number, binary}]

list_tags_for_stream_opts()

list_tags_for_stream_opts() :: [limit: pos_integer, exclusive_start_tag_key: binary]

put_record_opts()

put_record_opts() :: [explicit_hash_key: binary, sequence_number_for_ordering: binary]

put_records_record()

put_records_record() :: [data: binary, explicit_hash_key: binary]

shard_iterator_types()

shard_iterator_types ::
  :at_sequence_number |
  :after_sequence_number |
  :trim_horizon |
  :latest

stream_name()

stream_name() :: binary

stream_tags()

stream_tags() :: [{atom, binary} | {binary, binary}]

Functions

add_tags_to_stream(stream_name, tags)

add_tags_to_stream(stream_name :: binary, tags :: stream_tags) :: ExAws.Operation.JSON.t

Add tags to stream

create_stream(stream_name, shard_count \\ 1)

create_stream(stream_name :: stream_name, shard_count :: pos_integer) :: ExAws.Operation.JSON.t

Creates stream

decode_records(result)

delete_stream(stream_name)

delete_stream(stream_name :: stream_name) :: ExAws.Operation.JSON.t

Deletes stream

describe_stream(stream_name, opts \\ [])

describe_stream(stream_name :: stream_name, opts :: describe_stream_opts) :: ExAws.Operation.JSON.t

Describe Stream

get_records(shard_iterator, opts \\ [])

get_records(shard_iterator :: binary, opts :: get_records_opts) :: ExAws.Operation.JSON.t

Get stream records

get_shard_iterator(stream_name, shard_id, shard_iterator_type, opts \\ [])

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

list_streams()

list_streams() :: ExAws.Operation.JSON.t

Lists streams

list_tags_for_stream(stream_name, opts \\ [])

list_tags_for_stream(stream_name :: binary, opts :: list_tags_for_stream_opts) :: ExAws.Operation.JSON.t

List tags for a stream

merge_shards(stream_name, adjacent_shard, shard)

merge_shards(stream_name :: stream_name, adjacent_shard_id :: binary, shard_id :: binary) :: ExAws.Operation.JSON.t

Merge adjacent shards

put_record(stream_name, partition_key, data, opts \\ [])

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

put_records(stream_name, records)

put_records(stream_name :: stream_name, records :: [put_records_record]) :: ExAws.Operation.JSON.t

Put multiple records on a stream

remove_tags_from_stream(stream_name, tag_keys)

remove_tags_from_stream(stream_name :: binary, tag_keys :: [binary]) :: ExAws.Operation.JSON.t

Remove tags from stream

split_shard(stream_name, shard, new_starting_hash_key)

split_shard(stream_name :: binary, shard :: binary, new_starting_hash_key :: binary) :: ExAws.Operation.JSON.t

Split a shard