ExAws v1.1.1 ExAws.DynamoStreams

Operations on DynamoDB Streams

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

NOTE: When Mix.env in [:test, :dev] dynamo clients will run by default against Dynamodb local.

Enabling/Disabling streams on a table is performed through the Dynamo.update_table operation. The stream arn can then be retrieved with Dynamo.describe_table in the LatestStreamArn key.

Summary

Types

describe_stream_opts()

get_records_opts()

get_shard_iterator_opts()

list_stream_opts()

shard_iterator_types()

Functions

describe_stream(stream_arn, opts \\ [])

Describe Stream

get_records(shard_iterator, opts \\ [])

Get stream records

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

Get a shard iterator

list_streams(opts \\ [])

Lists all of the streams associated with an account. If you have multiple streams on a table (created by disabling/enabling the stream) you may have difficulty identifying the active stream from this operation

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() :: [{:sequence_number, binary}]

list_stream_opts()

list_stream_opts() :: [limit: pos_integer, exclusive_start_stream_arn: binary, table_name: binary]

shard_iterator_types()

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

stream_arn()

stream_arn() :: binary

Functions

describe_stream(stream_arn, opts \\ [])

describe_stream(stream_arn :: stream_arn, 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_arn, shard_id, shard_iterator_type, opts \\ [])

get_shard_iterator(stream_arn :: stream_arn, shard_id :: binary, shard_iterator_type :: shard_iterator_types, opts :: get_shard_iterator_opts) :: ExAws.Operation.JSON.t

Get a shard iterator

list_streams(opts \\ [])

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

Lists all of the streams associated with an account. If you have multiple streams on a table (created by disabling/enabling the stream) you may have difficulty identifying the active stream from this operation.