Module Smaws_Client_DynamoDBStreams.Types

type nonrec error_message = string
type nonrec trimmed_data_access_exception = {
  1. message : error_message 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 nonrec table_name = string
type nonrec string_attribute_value = string
type nonrec string_set_attribute_value = string_attribute_value list
type nonrec string_ = string
type nonrec stream_view_type =
  1. | KEYS_ONLY
  2. | NEW_AND_OLD_IMAGES
  3. | OLD_IMAGE
  4. | NEW_IMAGE
type nonrec stream_status =
  1. | DISABLED
  2. | DISABLING
  3. | ENABLED
  4. | ENABLING
type nonrec date = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec number_attribute_value = string
type nonrec binary_attribute_value = bytes
type nonrec number_set_attribute_value = number_attribute_value list
type nonrec binary_set_attribute_value = binary_attribute_value list
type nonrec attribute_name = string
type nonrec null_attribute_value = bool
type nonrec boolean_attribute_value = bool
type attribute_value =
  1. | BOOL of boolean_attribute_value
    (*

    An attribute of type Boolean. For example:

    "BOOL": true

    *)
  2. | NULL of null_attribute_value
    (*

    An attribute of type Null. For example:

    "NULL": true

    *)
  3. | L of list_attribute_value
    (*

    An attribute of type List. For example:

    "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

    *)
  4. | M of map_attribute_value
    (*

    An attribute of type Map. For example:

    "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

    *)
  5. | BS of binary_set_attribute_value
    (*

    An attribute of type Binary Set. For example:

    "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

    *)
  6. | NS of number_set_attribute_value
    (*

    An attribute of type Number Set. For example:

    "NS": ["42.2", "-19", "7.5", "3.14"]

    Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

    *)
  7. | SS of string_set_attribute_value
    (*

    An attribute of type String Set. For example:

    "SS": ["Giraffe", "Hippo" ,"Zebra"]

    *)
  8. | B of binary_attribute_value
    (*

    An attribute of type Binary. For example:

    "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

    *)
  9. | N of number_attribute_value
    (*

    An attribute of type Number. For example:

    "N": "123.45"

    Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

    *)
  10. | S of string_attribute_value
    (*

    An attribute of type String. For example:

    "S": "Hello"

    *)

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

and list_attribute_value = attribute_value list
and map_attribute_value = (attribute_name * attribute_value) list
type nonrec attribute_map = (attribute_name * attribute_value) list
type nonrec sequence_number = string
type nonrec positive_long_object = int
type nonrec 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 : positive_long_object option;
    (*

    The size of the stream record, in bytes.

    *)
  3. sequence_number : sequence_number option;
    (*

    The sequence number of the stream record.

    *)
  4. old_image : attribute_map option;
    (*

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

    *)
  5. new_image : attribute_map option;
    (*

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

    *)
  6. keys : attribute_map option;
    (*

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

    *)
  7. approximate_creation_date_time : date 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 nonrec stream_arn = string
type nonrec 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 : table_name option;
    (*

    The DynamoDB table with which the stream is associated.

    *)
  3. stream_arn : stream_arn option;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents all of the data describing a particular stream.

type nonrec stream_list = stream list
type nonrec key_schema_attribute_name = string
type nonrec key_type =
  1. | RANGE
  2. | HASH
type nonrec 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 : key_schema_attribute_name;
    (*

    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 nonrec key_schema = key_schema_element list
type nonrec shard_id = string
type nonrec sequence_number_range = {
  1. ending_sequence_number : sequence_number option;
    (*

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

    *)
  2. starting_sequence_number : sequence_number 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 nonrec shard = {
  1. parent_shard_id : shard_id 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 : shard_id option;
    (*

    The system-generated identifier for this shard.

    *)
}

A uniquely identified group of stream records within a stream.

type nonrec shard_description_list = shard list
type nonrec stream_description = {
  1. last_evaluated_shard_id : shard_id 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_description_list option;
    (*

    The shards that comprise the stream.

    *)
  3. key_schema : key_schema option;
    (*

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

    *)
  4. table_name : table_name option;
    (*

    The DynamoDB table with which the stream is associated.

    *)
  5. creation_request_date_time : date 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 : stream_arn option;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents all of the data describing a particular stream.

type nonrec shard_iterator_type =
  1. | AFTER_SEQUENCE_NUMBER
  2. | AT_SEQUENCE_NUMBER
  3. | LATEST
  4. | TRIM_HORIZON
type nonrec shard_iterator = string
type nonrec resource_not_found_exception = {
  1. message : error_message 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 nonrec operation_type =
  1. | REMOVE
  2. | MODIFY
  3. | INSERT
type nonrec 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 nonrec 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 nonrec record_list = record list
type nonrec positive_integer_object = int
type nonrec list_streams_output = {
  1. last_evaluated_stream_arn : stream_arn 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 nonrec list_streams_input = {
  1. exclusive_start_stream_arn : stream_arn 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 : positive_integer_object option;
    (*

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

    *)
  3. table_name : table_name 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 nonrec internal_server_error = {
  1. message : error_message option;
    (*

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

    *)
}

An error occurred on the server side.

type nonrec limit_exceeded_exception = {
  1. message : error_message 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 nonrec get_shard_iterator_output = {
  1. shard_iterator : shard_iterator 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 nonrec get_shard_iterator_input = {
  1. sequence_number : sequence_number 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 : shard_id;
    (*

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

    *)
  4. stream_arn : stream_arn;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents the input of a GetShardIterator operation.

type nonrec get_records_output = {
  1. next_shard_iterator : shard_iterator 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 nonrec get_records_input = {
  1. limit : positive_integer_object option;
    (*

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

    *)
  2. shard_iterator : shard_iterator;
    (*

    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 nonrec expired_iterator_exception = {
  1. message : error_message 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 nonrec 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 nonrec describe_stream_input = {
  1. exclusive_start_shard_id : shard_id 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 : positive_integer_object option;
    (*

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

    *)
  3. stream_arn : stream_arn;
    (*

    The Amazon Resource Name (ARN) for the stream.

    *)
}

Represents the input of a DescribeStream operation.