Module Smaws_Client_DynamoDBStreams

DynamoDB Streams client library built on EIO.

Types

type trimmed_data_access_exception = {
  1. message : string option;
    (*

    "The data you are trying to access has been trimmed.

    *)
}

The operation attempted to read past the oldest stream record in a shard.

In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

  • You request a shard iterator with a sequence number older than the trim point (24 hours).
  • You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.
type stream_view_type =
  1. | KEYS_ONLY
  2. | NEW_AND_OLD_IMAGES
  3. | OLD_IMAGE
  4. | NEW_IMAGE
type stream_status =
  1. | DISABLED
  2. | DISABLING
  3. | ENABLED
  4. | ENABLING
type attribute_value =
  1. | BOOL of bool
  2. | NULL of bool
  3. | L of attribute_value list
  4. | M of (string * attribute_value) list
  5. | BS of bytes list
  6. | NS of string list
  7. | SS of string list
  8. | B of bytes
  9. | N of string
  10. | S of string
type stream_record = {
  1. stream_view_type : stream_view_type option;
    (*

    The type of data from the modified DynamoDB item that was captured in this stream record:

    • KEYS_ONLY - only the key attributes of the modified item.
    • NEW_IMAGE - the entire item, as it appeared after it was modified.
    • OLD_IMAGE - the entire item, as it appeared before it was modified.
    • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.
    *)
  2. size_bytes : int option;
    (*

    The size of the stream record, in bytes.

    *)
  3. sequence_number : string option;
    (*

    The sequence number of the stream record.

    *)
  4. old_image : (string * attribute_value) list option;
    (*

    The item in the DynamoDB table as it appeared before it was modified.

    *)
  5. new_image : (string * attribute_value) list option;
    (*

    The item in the DynamoDB table as it appeared after it was modified.

    *)
  6. keys : (string * attribute_value) list option;
    (*

    The primary key attribute(s) for the DynamoDB item that was modified.

    *)
  7. approximate_creation_date_time : float option;
    (*

    The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second.

    *)
}

A description of a single data modification that was performed on an item in a DynamoDB table.

type stream = {
  1. stream_label : string option;
    (*

    A timestamp, in ISO 8601 format, for this stream.

    Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

    • the Amazon Web Services customer ID.
    • the table name
    • the StreamLabel
    *)
  2. table_name : string option;
    (*

    The DynamoDB table with which the stream is associated.

    *)
  3. stream_arn : string option;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents all of the data describing a particular stream.

type key_type =
  1. | RANGE
  2. | HASH
type key_schema_element = {
  1. key_type : key_type;
    (*

    The role that this key attribute will assume:

    • HASH - partition key
    • RANGE - sort key

    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

    *)
  2. attribute_name : string;
    (*

    The name of a key attribute.

    *)
}

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

type sequence_number_range = {
  1. ending_sequence_number : string option;
    (*

    The last sequence number for the stream records contained within a shard. String contains numeric characters only.

    *)
  2. starting_sequence_number : string option;
    (*

    The first sequence number for the stream records contained within a shard. String contains numeric characters only.

    *)
}

The beginning and ending sequence numbers for the stream records contained within a shard.

type shard = {
  1. parent_shard_id : string option;
    (*

    The shard ID of the current shard's parent.

    *)
  2. sequence_number_range : sequence_number_range option;
    (*

    The range of possible sequence numbers for the shard.

    *)
  3. shard_id : string option;
    (*

    The system-generated identifier for this shard.

    *)
}

A uniquely identified group of stream records within a stream.

type stream_description = {
  1. last_evaluated_shard_id : string option;
    (*

    The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

    If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

    If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

    *)
  2. shards : shard list option;
    (*

    The shards that comprise the stream.

    *)
  3. key_schema : key_schema_element list option;
    (*

    The key attribute(s) of the stream's DynamoDB table.

    *)
  4. table_name : string option;
    (*

    The DynamoDB table with which the stream is associated.

    *)
  5. creation_request_date_time : float option;
    (*

    The date and time when the request to create this stream was issued.

    *)
  6. stream_view_type : stream_view_type option;
    (*

    Indicates the format of the records within this stream:

    • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
    • NEW_IMAGE - entire items from the table, as they appeared after they were modified.
    • OLD_IMAGE - entire items from the table, as they appeared before they were modified.
    • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
    *)
  7. stream_status : stream_status option;
    (*

    Indicates the current status of the stream:

    • ENABLING - Streams is currently being enabled on the DynamoDB table.
    • ENABLED - the stream is enabled.
    • DISABLING - Streams is currently being disabled on the DynamoDB table.
    • DISABLED - the stream is disabled.
    *)
  8. stream_label : string option;
    (*

    A timestamp, in ISO 8601 format, for this stream.

    Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

    • the Amazon Web Services customer ID.
    • the table name
    • the StreamLabel
    *)
  9. stream_arn : string option;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents all of the data describing a particular stream.

type shard_iterator_type =
  1. | AFTER_SEQUENCE_NUMBER
  2. | AT_SEQUENCE_NUMBER
  3. | LATEST
  4. | TRIM_HORIZON
type resource_not_found_exception = {
  1. message : string option;
    (*

    The resource which is being requested does not exist.

    *)
}

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

type operation_type =
  1. | REMOVE
  2. | MODIFY
  3. | INSERT
type identity = {
  1. type_ : string option;
    (*

    The type of the identity. For Time To Live, the type is "Service".

    *)
  2. principal_id : string option;
    (*

    A unique identifier for the entity that made the call. For Time To Live, the principalId is "dynamodb.amazonaws.com".

    *)
}

Contains details about the type of identity that made the request.

type record = {
  1. user_identity : identity option;
    (*

    Items that are deleted by the Time to Live process after expiration have the following fields:

    • Records[].userIdentity.type

      "Service"

    • Records[].userIdentity.principalId

      "dynamodb.amazonaws.com"

    *)
  2. dynamodb : stream_record option;
    (*

    The main body of the stream record, containing all of the DynamoDB-specific fields.

    *)
  3. aws_region : string option;
    (*

    The region in which the GetRecords request was received.

    *)
  4. event_source : string option;
    (*

    The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

    *)
  5. event_version : string option;
    (*

    The version number of the stream record format. This number is updated whenever the structure of Record is modified.

    Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.

    *)
  6. event_name : operation_type option;
    (*

    The type of data modification that was performed on the DynamoDB table:

    • INSERT - a new item was added to the table.
    • MODIFY - one or more of an existing item's attributes were modified.
    • REMOVE - the item was deleted from the table
    *)
  7. event_i_d : string option;
    (*

    A globally unique identifier for the event that was recorded in this stream record.

    *)
}

A description of a unique event within a stream.

type list_streams_output = {
  1. last_evaluated_stream_arn : string option;
    (*

    The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

    If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

    If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.

    *)
  2. streams : stream list option;
    (*

    A list of stream descriptors associated with the current account and endpoint.

    *)
}

Represents the output of a ListStreams operation.

type list_streams_input = {
  1. exclusive_start_stream_arn : string option;
    (*

    The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

    *)
  2. limit : int option;
    (*

    The maximum number of streams to return. The upper limit is 100.

    *)
  3. table_name : string option;
    (*

    If this parameter is provided, then only the streams associated with this table name are returned.

    *)
}

Represents the input of a ListStreams operation.

type internal_server_error = {
  1. message : string option;
    (*

    The server encountered an internal error trying to fulfill the request.

    *)
}

An error occurred on the server side.

type limit_exceeded_exception = {
  1. message : string option;
    (*

    Too many operations for a given subscriber.

    *)
}

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

type get_shard_iterator_output = {
  1. shard_iterator : string option;
    (*

    The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.

    *)
}

Represents the output of a GetShardIterator operation.

type get_shard_iterator_input = {
  1. sequence_number : string option;
    (*

    The sequence number of a stream record in the shard from which to start reading.

    *)
  2. shard_iterator_type : shard_iterator_type;
    (*

    Determines how the shard iterator is used to start reading stream records from the shard:

    • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.
    • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.
    • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.
    • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.
    *)
  3. shard_id : string;
    (*

    The identifier of the shard. The iterator will be returned for this shard ID.

    *)
  4. stream_arn : string;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents the input of a GetShardIterator operation.

type get_records_output = {
  1. next_shard_iterator : string option;
    (*

    The next position in the shard from which to start sequentially reading stream records. If set to null, the shard has been closed and the requested iterator will not return any more data.

    *)
  2. records : record list option;
    (*

    The stream records from the shard, which were retrieved using the shard iterator.

    *)
}

Represents the output of a GetRecords operation.

type get_records_input = {
  1. limit : int option;
    (*

    The maximum number of records to return from the shard. The upper limit is 1000.

    *)
  2. shard_iterator : string;
    (*

    A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

    *)
}

Represents the input of a GetRecords operation.

type expired_iterator_exception = {
  1. message : string option;
    (*

    The provided iterator exceeds the maximum age allowed.

    *)
}

The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator action.

type describe_stream_output = {
  1. stream_description : stream_description option;
    (*

    A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.

    *)
}

Represents the output of a DescribeStream operation.

type describe_stream_input = {
  1. exclusive_start_shard_id : string option;
    (*

    The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

    *)
  2. limit : int option;
    (*

    The maximum number of shard objects to return. The upper limit is 100.

    *)
  3. stream_arn : string;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents the input of a DescribeStream operation.

Amazon DynamoDB Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.

type base_document = Smaws_Lib.Json.t

Builders

val make_stream_record : ?stream_view_type:stream_view_type -> ?size_bytes:int -> ?sequence_number:string -> ?old_image:(string * attribute_value) list -> ?new_image:(string * attribute_value) list -> ?keys:(string * attribute_value) list -> ?approximate_creation_date_time:float -> unit -> stream_record

Create a stream_record type

val make_stream : ?stream_label:string -> ?table_name:string -> ?stream_arn:string -> unit -> stream

Create a stream type

val make_key_schema_element : key_type:key_type -> attribute_name:string -> unit -> key_schema_element

Create a key_schema_element type

val make_sequence_number_range : ?ending_sequence_number:string -> ?starting_sequence_number:string -> unit -> sequence_number_range

Create a sequence_number_range type

val make_shard : ?parent_shard_id:string -> ?sequence_number_range:sequence_number_range -> ?shard_id:string -> unit -> shard

Create a shard type

val make_stream_description : ?last_evaluated_shard_id:string -> ?shards:shard list -> ?key_schema:key_schema_element list -> ?table_name:string -> ?creation_request_date_time:float -> ?stream_view_type:stream_view_type -> ?stream_status:stream_status -> ?stream_label:string -> ?stream_arn:string -> unit -> stream_description

Create a stream_description type

val make_identity : ?type_:string -> ?principal_id:string -> unit -> identity

Create a identity type

val make_record : ?user_identity:identity -> ?dynamodb:stream_record -> ?aws_region:string -> ?event_source:string -> ?event_version:string -> ?event_name:operation_type -> ?event_i_d:string -> unit -> record

Create a record type

val make_list_streams_output : ?last_evaluated_stream_arn:string -> ?streams:stream list -> unit -> list_streams_output

Create a list_streams_output type

val make_list_streams_input : ?exclusive_start_stream_arn:string -> ?limit:int -> ?table_name:string -> unit -> list_streams_input

Create a list_streams_input type

val make_get_shard_iterator_output : ?shard_iterator:string -> unit -> get_shard_iterator_output

Create a get_shard_iterator_output type

val make_get_shard_iterator_input : ?sequence_number:string -> shard_iterator_type:shard_iterator_type -> shard_id:string -> stream_arn:string -> unit -> get_shard_iterator_input

Create a get_shard_iterator_input type

val make_get_records_output : ?next_shard_iterator:string -> ?records:record list -> unit -> get_records_output

Create a get_records_output type

val make_get_records_input : ?limit:int -> shard_iterator:string -> unit -> get_records_input

Create a get_records_input type

val make_describe_stream_output : ?stream_description:stream_description -> unit -> describe_stream_output

Create a describe_stream_output type

val make_describe_stream_input : ?exclusive_start_shard_id:string -> ?limit:int -> stream_arn:string -> unit -> describe_stream_input

Create a describe_stream_input type

Operations

module DescribeStream : sig ... end
module GetRecords : sig ... end
module GetShardIterator : sig ... end
module ListStreams : sig ... end