ExAws v0.4.19 ExAws.Kinesis.Client behaviour
Defines a Kinesis client.
Usage:
defmodule MyApp.Kinesis do
use ExAws.Kinesis.Client, otp_app: :my_otp_app
endIn your config
config :my_otp_app, :ex_aws,
kinesis: [], # kinesis config goes here
dynamodb: [], # you get the ideaYou can now use MyApp.Kinesis as the root module for the Kinesis api without needing to pass in a particular configuration. This enables different otp apps to configure their AWS configuration separately.
The alignment with a particular OTP app however is entirely optional. The following also works:
defmodule MyApp.Kinesis do
use ExAws.Kinesis.Client
def config_root do
Application.get_all_env(:my_aws_config_root)
end
endExAws now expects the config for that kinesis client to live under
config :my_aws_config_root
kinesis: [] # Kinesis config goes hereDefault config values can be found in ExAws.Config
http://docs.aws.amazon.com/kinesis/latest/APIReference/API_Operations.html
Summary
Callbacks
Add tags to stream
Retrieves the root AWS config for this client
Creates stream
Deletes stream
Describe Stream
Get stream records
Get a shard iterator
Lists streams
Add tags to stream
Merge adjacent shards
Puts a record on a stream
Put multiple records on a stream
Remove tags from stream
Enables custom request handling
Split a shard
Returns a stream of kinesis records NOTE: This stream is basically INFINITE, in that it runs until the shard it is reading from closes, which may be never. If you want it to take records until there are no more (at the moment), something like
Same as describe_stream/1,2 except the shards key is a stream and will automatically handle pagination Returns the normally shaped AWS response, except the Shards key is now a stream
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 |
:lateststream_name :: binarystream_records_opts :: [limit: pos_integer, sleep_between_req_time: non_neg_integer]Callbacks
Specs
add_tags_to_stream(stream_name :: binary, tags :: stream_tags) :: ExAws.Kinesis.Request.response_tAdd tags to stream
Specs
create_stream(stream_name :: stream_name) :: ExAws.Kinesis.Request.response_tCreates stream
Specs
create_stream(stream_name :: stream_name, shard_count :: pos_integer) :: ExAws.Kinesis.Request.response_tSpecs
delete_stream(stream_name :: stream_name) :: ExAws.Kinesis.Request.response_tDeletes stream
Specs
describe_stream(stream_name :: stream_name) :: ExAws.Kinesis.Request.response_tDescribe Stream
Specs
describe_stream(stream_name :: stream_name, opts :: describe_stream_opts) :: ExAws.Kinesis.Request.response_tSpecs
get_records(shard_iterator :: binary) :: ExAws.Kinesis.Request.response_tGet stream records
Specs
get_records(shard_iterator :: binary, opts :: get_records_opts) :: ExAws.Kinesis.Request.response_tSpecs
get_shard_iterator(stream_name :: stream_name, shard_id :: binary, shard_iterator_type :: shard_iterator_types) :: ExAws.Kinesis.Request.response_tGet a shard iterator
Specs
get_shard_iterator(stream_name :: stream_name, shard_id :: binary, shard_iterator_type :: shard_iterator_types, opts :: get_shard_iterator_opts) :: ExAws.Kinesis.Request.response_tSpecs
list_tags_for_stream(stream_name :: binary) :: termAdd tags to stream
Specs
list_tags_for_stream(stream_name :: binary, opts :: list_tags_for_stream_opts) :: ExAws.Kinesis.Request.response_tSpecs
merge_shards(stream_name :: stream_name, adjacent_shard_id :: binary, shard_id :: binary) :: ExAws.Kinesis.Request.response_tMerge adjacent shards
Specs
put_record(stream_name :: stream_name, partition_key :: binary, data :: binary) :: ExAws.Kinesis.Request.response_tPuts a record on a stream
Specs
put_record(stream_name :: stream_name, partition_key :: binary, data :: binary, opts :: put_record_opts) :: ExAws.Kinesis.Request.response_tSpecs
put_records(stream_name :: stream_name, records :: [put_records_record]) :: ExAws.Kinesis.Request.response_tPut multiple records on a stream
Specs
remove_tags_from_stream(stream_name :: binary, tag_keys :: [binary]) :: ExAws.Kinesis.Request.response_tRemove tags from stream
Specs
request(client :: %{}, data :: %{}, action :: atom) :: termEnables custom request handling.
By default this just forwards the request to the ExAws.Kinesis.Request.request/2.
However, this can be overriden in your client to provide pre-request adjustments to headers, params, etc.
Specs
split_shard(stream_name :: binary, shard :: binary, new_starting_hash_key :: binary) :: ExAws.Kinesis.Request.response_tSplit a shard
Specs
stream_records(shard_iterator :: binary) :: Enumerable.tReturns a stream of kinesis records NOTE: This stream is basically INFINITE, in that it runs until the shard it is reading from closes, which may be never. If you want it to take records until there are no more (at the moment), something like
"my-stream"
|> Kinesis.stream_records
|> Enum.take_while(fn(val) -> !match?(%{"Data" => []}, val))ought to do the trick.
The optional iterator_fun is a function that is called after every actual AWS request. Generally speaking you won’t need this, but it can be handy if you’re trying to prevent flooding. See Mix.Tasks.Kinesis.Tail.get_records/1 for an example.
The sleep_between_req_time is the amount of time that this function will sleep between requests to avoid exceeding the provisioned read capacity. It defaults to 200ms.
Specs
stream_records(shard_iterator :: binary, opts :: stream_records_opts) :: Enumerable.tSpecs
stream_records(shard_iterator :: binary, opts :: stream_records_opts, each_req_fun :: Fun) :: Enumerable.tSpecs
stream_shards(stream_name :: stream_name) :: Enumerable.tSame as describe_stream/1,2 except the shards key is a stream and will automatically handle pagination Returns the normally shaped AWS response, except the Shards key is now a stream
Specs
stream_shards(stream_name :: stream_name, opts :: describe_stream_opts) :: Enumerable.t