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.
", "operations": { "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.
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, then that shard is closed and can no longer receive more data.
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.
GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.
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.
A shard iterator expires 15 minutes after it is returned to the requester.
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.
You can call ListStreams at a maximum rate of 5 times per second.
The primary key attribute(s) for the DynamoDB item that was modified.
", "StreamRecord$NewImage": "The item in the DynamoDB table as it appeared after it was modified.
", "StreamRecord$OldImage": "The item in the DynamoDB table as it appeared before it was modified.
" } }, "AttributeName": { "base": null, "refs": { "AttributeMap$key": null, "MapAttributeValue$key": null } }, "AttributeValue": { "base": "Represents the data for an attribute. You can set one, and only one, of the elements.
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
", "refs": { "AttributeMap$value": null, "ListAttributeValue$member": null, "MapAttributeValue$value": null } }, "BinaryAttributeValue": { "base": null, "refs": { "AttributeValue$B": "A Binary data type.
", "BinarySetAttributeValue$member": null } }, "BinarySetAttributeValue": { "base": null, "refs": { "AttributeValue$BS": "A Binary Set data type.
" } }, "BooleanAttributeValue": { "base": null, "refs": { "AttributeValue$BOOL": "A Boolean data type.
" } }, "Date": { "base": null, "refs": { "StreamDescription$CreationRequestDateTime": "The date and time when the request to create this stream was issued.
", "StreamRecord$ApproximateCreationDateTime": "The approximate date and time when the stream record was created, in UNIX epoch time format.
" } }, "DescribeStreamInput": { "base": "Represents the input of a DescribeStream operation.
Represents the output of a DescribeStream operation.
The provided iterator exceeds the maximum age allowed.
", "InternalServerError$message": "The server encountered an internal error trying to fulfill the request.
", "LimitExceededException$message": "Too many operations for a given subscriber.
", "ResourceNotFoundException$message": "The resource which is being requested does not exist.
", "TrimmedDataAccessException$message": "\"The data you are trying to access has been trimmed.
" } }, "ExpiredIteratorException": { "base": "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.
Represents the input of a GetRecords operation.
Represents the output of a GetRecords operation.
Represents the input of a GetShardIterator operation.
Represents the output of a GetShardIterator operation.
Contains details about the type of identity that made the request.
", "refs": { "Record$userIdentity": "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\"
An error occurred on the server side.
", "refs": { } }, "KeySchema": { "base": null, "refs": { "StreamDescription$KeySchema": "The key attribute(s) of the stream's DynamoDB table.
" } }, "KeySchemaAttributeName": { "base": null, "refs": { "KeySchemaElement$AttributeName": "The name of a key attribute.
" } }, "KeySchemaElement": { "base": "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 (partition key) would be represented by one KeySchemaElement. A composite primary key (partition key and sort key) would require one KeySchemaElement for the partition key, and another KeySchemaElement for the 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.
The attribute data, consisting of the data type and the attribute value itself.
" } }, "LimitExceededException": { "base": "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
", "refs": { } }, "ListAttributeValue": { "base": null, "refs": { "AttributeValue$L": "A List data type.
" } }, "ListStreamsInput": { "base": "Represents the input of a ListStreams operation.
Represents the output of a ListStreams operation.
A Map data type.
" } }, "NullAttributeValue": { "base": null, "refs": { "AttributeValue$NULL": "A Null data type.
" } }, "NumberAttributeValue": { "base": null, "refs": { "AttributeValue$N": "A Number data type.
", "NumberSetAttributeValue$member": null } }, "NumberSetAttributeValue": { "base": null, "refs": { "AttributeValue$NS": "A Number Set data type.
" } }, "OperationType": { "base": null, "refs": { "Record$eventName": "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
The maximum number of shard objects to return. The upper limit is 100.
", "GetRecordsInput$Limit": "The maximum number of records to return from the shard. The upper limit is 1000.
", "ListStreamsInput$Limit": "The maximum number of streams to return. The upper limit is 100.
" } }, "PositiveLongObject": { "base": null, "refs": { "StreamRecord$SizeBytes": "The size of the stream record, in bytes.
" } }, "Record": { "base": "A description of a unique event within a stream.
", "refs": { "RecordList$member": null } }, "RecordList": { "base": null, "refs": { "GetRecordsOutput$Records": "The stream records from the shard, which were retrieved using the shard iterator.
" } }, "ResourceNotFoundException": { "base": "The operation tried to access a nonexistent stream.
", "refs": { } }, "SequenceNumber": { "base": null, "refs": { "GetShardIteratorInput$SequenceNumber": "The sequence number of a stream record in the shard from which to start reading.
", "SequenceNumberRange$StartingSequenceNumber": "The first sequence number.
", "SequenceNumberRange$EndingSequenceNumber": "The last sequence number.
", "StreamRecord$SequenceNumber": "The sequence number of the stream record.
" } }, "SequenceNumberRange": { "base": "The beginning and ending sequence numbers for the stream records contained within a shard.
", "refs": { "Shard$SequenceNumberRange": "The range of possible sequence numbers for the shard.
" } }, "Shard": { "base": "A uniquely identified group of stream records within a stream.
", "refs": { "ShardDescriptionList$member": null } }, "ShardDescriptionList": { "base": null, "refs": { "StreamDescription$Shards": "The shards that comprise the stream.
" } }, "ShardId": { "base": null, "refs": { "DescribeStreamInput$ExclusiveStartShardId": "The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.
The identifier of the shard. The iterator will be returned for this shard ID.
", "Shard$ShardId": "The system-generated identifier for this shard.
", "Shard$ParentShardId": "The shard ID of the current shard's parent.
", "StreamDescription$LastEvaluatedShardId": "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.
A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
", "GetRecordsOutput$NextShardIterator": "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.
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.
" } }, "ShardIteratorType": { "base": null, "refs": { "GetShardIteratorInput$ShardIteratorType": "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.
Represents all of the data describing a particular stream.
", "refs": { "StreamList$member": null } }, "StreamArn": { "base": null, "refs": { "DescribeStreamInput$StreamArn": "The Amazon Resource Name (ARN) for the stream.
", "GetShardIteratorInput$StreamArn": "The Amazon Resource Name (ARN) for the stream.
", "ListStreamsInput$ExclusiveStartStreamArn": "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.
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.
The Amazon Resource Name (ARN) for the stream.
", "StreamDescription$StreamArn": "The Amazon Resource Name (ARN) for the stream.
" } }, "StreamDescription": { "base": "Represents all of the data describing a particular stream.
", "refs": { "DescribeStreamOutput$StreamDescription": "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.
" } }, "StreamList": { "base": null, "refs": { "ListStreamsOutput$Streams": "A list of stream descriptors associated with the current account and endpoint.
" } }, "StreamRecord": { "base": "A description of a single data modification that was performed on an item in a DynamoDB table.
", "refs": { "Record$dynamodb": "The main body of the stream record, containing all of the DynamoDB-specific fields.
" } }, "StreamStatus": { "base": null, "refs": { "StreamDescription$StreamStatus": "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.
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.
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.
A unique identifier for the entity that made the call. For Time To Live, the principalId is \"dynamodb.amazonaws.com\".
", "Identity$Type": "The type of the identity. For Time To Live, the type is \"Service\".
", "Record$eventID": "A globally unique identifier for the event that was recorded in this stream record.
", "Record$eventVersion": "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.
The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
The region in which the GetRecords request was received.
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 AWS customer ID.
the table name
the StreamLabel
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 AWS customer ID.
the table name
the StreamLabel
A String data type.
", "StringSetAttributeValue$member": null } }, "StringSetAttributeValue": { "base": null, "refs": { "AttributeValue$SS": "A String Set data type.
" } }, "TableName": { "base": null, "refs": { "ListStreamsInput$TableName": "If this parameter is provided, then only the streams associated with this table name are returned.
", "Stream$TableName": "The DynamoDB table with which the stream is associated.
", "StreamDescription$TableName": "The DynamoDB table with which the stream is associated.
" } }, "TrimmedDataAccessException": { "base": "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.