ExAws.Dynamodb.Streams.Core

Amazon DynamoDB Streams

Amazon DynamoDB Streams

This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the Amazon DynamoDB Developer Guide.

Note that this document is intended for use with the following DynamoDB documentation:

The following are short descriptions of each low-level DynamoDB Streams API action, organized by function.

Source

Summary

describe_stream!(client, input)

Same as describe_stream/2 but raise on error

describe_stream(client, input)

DescribeStream

get_records!(client, input)

Same as get_records/2 but raise on error

get_records(client, input)

GetRecords

get_shard_iterator!(client, input)

Same as get_shard_iterator/2 but raise on error

get_shard_iterator(client, input)

GetShardIterator

list_streams!(client, input)

Same as list_streams/2 but raise on error

list_streams(client, input)

ListStreams

Types

get_shard_iterator_input :: [sequence_number: sequence_number, shard_id: shard_id, shard_iterator_type: shard_iterator_type, stream_arn: stream_arn]

stream_view_type :: binary

key_type :: binary

error_message :: binary

attribute_name :: binary

get_shard_iterator_output :: [{:shard_iterator, shard_iterator}]

stream_record :: [keys: attribute_map, new_image: attribute_map, old_image: attribute_map, sequence_number: sequence_number, size_bytes: positive_long_object, stream_view_type: stream_view_type]

dynamodb_streams_record :: [aws_region: binary, dynamodb: stream_record, event_id: binary, event_name: operation_type, event_source: binary, event_version: binary]

table_name :: binary

stream_description :: [creation_request_date_time: date, key_schema: key_schema, last_evaluated_shard_id: shard_id, shards: shard_description_list, stream_arn: stream_arn, stream_label: binary, stream_status: stream_status, stream_view_type: stream_view_type, table_name: table_name]

sequence_number_range :: [ending_sequence_number: sequence_number, starting_sequence_number: sequence_number]

shard_iterator :: binary

date :: integer

list_streams_output :: [last_evaluated_stream_arn: stream_arn, streams: stream_list]

list_streams_input :: [exclusive_start_stream_arn: stream_arn, limit: positive_integer_object, table_name: table_name]

stream_arn :: binary

stream :: [stream_arn: stream_arn, stream_label: binary, table_name: table_name]

operation_type :: binary

describe_stream_output :: [{:stream_description, stream_description}]

describe_stream_input :: [exclusive_start_shard_id: shard_id, limit: positive_integer_object, stream_arn: stream_arn]

stream_status :: binary

get_records_output :: [next_shard_iterator: shard_iterator, records: record_list]

shard_id :: binary

shard :: [parent_shard_id: shard_id, sequence_number_range: sequence_number_range, shard_id: shard_id]

sequence_number :: binary

key_schema_element :: [attribute_name: key_schema_attribute_name, key_type: key_type]

Functions

describe_stream(client, input)

Specs:

  • describe_stream(client :: ExAws.Dynamodb.Streams.t, input :: describe_stream_input) :: ExAws.Request.JSON.response_t

DescribeStream

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

Note:You can call DescribeStream at a maximum rate of 10 times per second.

Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, the that shared is closed and can no longer receive more data.

Source
describe_stream!(client, input)

Specs:

  • describe_stream!(client :: ExAws.Dynamodb.Streams.t, input :: describe_stream_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_stream/2 but raise on error.

Source
get_records(client, input)

Specs:

  • get_records(client :: ExAws.Dynamodb.Streams.t, input :: get_records_input) :: ExAws.Request.JSON.response_t

GetRecords

Retrieves the stream records from a given shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.

Note:GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first.

Source
get_records!(client, input)

Specs:

  • get_records!(client :: ExAws.Dynamodb.Streams.t, input :: get_records_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_records/2 but raise on error.

Source
get_shard_iterator(client, input)

Specs:

  • get_shard_iterator(client :: ExAws.Dynamodb.Streams.t, input :: get_shard_iterator_input) :: ExAws.Request.JSON.response_t

GetShardIterator

Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.

Note:A shard iterator expires 15 minutes after it is returned to the requester.

Source
get_shard_iterator!(client, input)

Specs:

  • get_shard_iterator!(client :: ExAws.Dynamodb.Streams.t, input :: get_shard_iterator_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_shard_iterator/2 but raise on error.

Source
list_streams(client, input)

Specs:

  • list_streams(client :: ExAws.Dynamodb.Streams.t, input :: list_streams_input) :: ExAws.Request.JSON.response_t

ListStreams

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.

Note:You can call ListStreams at a maximum rate of 5 times per second.

Source
list_streams!(client, input)

Specs:

  • list_streams!(client :: ExAws.Dynamodb.Streams.t, input :: list_streams_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_streams/2 but raise on error.

Source