Amazon DynamoDB Streams 2012-08-10
- Client: Aws\DynamoDbStreams\DynamoDbStreamsClient
- Service ID: streams.dynamodb
- Version: 2012-08-10
This page describes the parameters and results for the operations of the Amazon DynamoDB Streams (2012-08-10), and shows how to use the Aws\DynamoDbStreams\DynamoDbStreamsClient object to call the described operations. This documentation is specific to the 2012-08-10 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- DescribeStream ( array $params = [] )
- 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.
- GetRecords ( array $params = [] )
- Retrieves the stream records from a given shard.
- GetShardIterator ( array $params = [] )
- Returns a shard iterator.
- ListStreams ( array $params = [] )
- Returns an array of stream ARNs associated with the current account and endpoint.
Operations
DescribeStream
$result = $client->describeStream
([/* ... */]); $promise = $client->describeStreamAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeStream([ 'ExclusiveStartShardId' => '<string>', 'Limit' => <integer>, 'StreamArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ExclusiveStartShardId
-
- Type: string
The shard ID of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedShardId
in the previous operation. - Limit
-
- Type: int
The maximum number of shard objects to return. The upper limit is 100.
- StreamArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the stream.
Result Syntax
[ 'StreamDescription' => [ 'CreationRequestDateTime' => <DateTime>, 'KeySchema' => [ [ 'AttributeName' => '<string>', 'KeyType' => 'HASH|RANGE', ], // ... ], 'LastEvaluatedShardId' => '<string>', 'Shards' => [ [ 'ParentShardId' => '<string>', 'SequenceNumberRange' => [ 'EndingSequenceNumber' => '<string>', 'StartingSequenceNumber' => '<string>', ], 'ShardId' => '<string>', ], // ... ], 'StreamArn' => '<string>', 'StreamLabel' => '<string>', 'StreamStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED', 'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY', 'TableName' => '<string>', ], ]
Result Details
Members
- StreamDescription
-
- Type: StreamDescription structure
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.
Errors
- ResourceNotFoundException:
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.- InternalServerError:
An error occurred on the server side.
Examples
Example 1: To describe a stream with a given stream ARN
The following example describes a stream with a given stream ARN.
$result = $client->describeStream([ 'StreamArn' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252', ]);
Result syntax:
[ 'StreamDescription' => [ 'CreationRequestDateTime' =>, 'KeySchema' => [ [ 'AttributeName' => 'ForumName', 'KeyType' => 'HASH', ], [ 'AttributeName' => 'Subject', 'KeyType' => 'RANGE', ], ], 'Shards' => [ [ 'SequenceNumberRange' => [ 'EndingSequenceNumber' => '20500000000000000910398', 'StartingSequenceNumber' => '20500000000000000910398', ], 'ShardId' => 'shardId-00000001414562045508-2bac9cd2', ], [ 'ParentShardId' => 'shardId-00000001414562045508-2bac9cd2', 'SequenceNumberRange' => [ 'EndingSequenceNumber' => '820400000000000001192334', 'StartingSequenceNumber' => '820400000000000001192334', ], 'ShardId' => 'shardId-00000001414576573621-f55eea83', ], [ 'ParentShardId' => 'shardId-00000001414576573621-f55eea83', 'SequenceNumberRange' => [ 'EndingSequenceNumber' => '1683700000000000001135967', 'StartingSequenceNumber' => '1683700000000000001135967', ], 'ShardId' => 'shardId-00000001414592258131-674fd923', ], [ 'ParentShardId' => 'shardId-00000001414592258131-674fd923', 'SequenceNumberRange' => [ 'StartingSequenceNumber' => '2574600000000000000935255', ], 'ShardId' => 'shardId-00000001414608446368-3a1afbaf', ], ], 'StreamArn' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252', 'StreamLabel' => '2015-05-20T20:51:10.252', 'StreamStatus' => 'ENABLED', 'StreamViewType' => 'NEW_AND_OLD_IMAGES', 'TableName' => 'Forum', ], ]
GetRecords
$result = $client->getRecords
([/* ... */]); $promise = $client->getRecordsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getRecords([ 'Limit' => <integer>, 'ShardIterator' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of records to return from the shard. The upper limit is 1000.
- ShardIterator
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'NextShardIterator' => '<string>', 'Records' => [ [ 'awsRegion' => '<string>', 'dynamodb' => [ 'ApproximateCreationDateTime' => <DateTime>, 'Keys' => [ '<AttributeName>' => [ 'B' => <string || resource || Psr\Http\Message\StreamInterface>, 'BOOL' => true || false, 'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...], 'L' => [ [...], // RECURSIVE // ... ], 'M' => [ '<AttributeName>' => [...], // RECURSIVE // ... ], 'N' => '<string>', 'NS' => ['<string>', ...], 'NULL' => true || false, 'S' => '<string>', 'SS' => ['<string>', ...], ], // ... ], 'NewImage' => [ '<AttributeName>' => [ 'B' => <string || resource || Psr\Http\Message\StreamInterface>, 'BOOL' => true || false, 'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...], 'L' => [ [...], // RECURSIVE // ... ], 'M' => [ '<AttributeName>' => [...], // RECURSIVE // ... ], 'N' => '<string>', 'NS' => ['<string>', ...], 'NULL' => true || false, 'S' => '<string>', 'SS' => ['<string>', ...], ], // ... ], 'OldImage' => [ '<AttributeName>' => [ 'B' => <string || resource || Psr\Http\Message\StreamInterface>, 'BOOL' => true || false, 'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...], 'L' => [ [...], // RECURSIVE // ... ], 'M' => [ '<AttributeName>' => [...], // RECURSIVE // ... ], 'N' => '<string>', 'NS' => ['<string>', ...], 'NULL' => true || false, 'S' => '<string>', 'SS' => ['<string>', ...], ], // ... ], 'SequenceNumber' => '<string>', 'SizeBytes' => <integer>, 'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY', ], 'eventID' => '<string>', 'eventName' => 'INSERT|MODIFY|REMOVE', 'eventSource' => '<string>', 'eventVersion' => '<string>', 'userIdentity' => [ 'PrincipalId' => '<string>', 'Type' => '<string>', ], ], // ... ], ]
Result Details
Members
- NextShardIterator
-
- Type: string
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. - Records
-
- Type: Array of Record structures
The stream records from the shard, which were retrieved using the shard iterator.
Errors
- ResourceNotFoundException:
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.- LimitExceededException:
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
, andRestoreTableToPointInTime
.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.
- InternalServerError:
An error occurred on the server side.
- ExpiredIteratorException:
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.- TrimmedDataAccessException:
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.
-
Examples
Example 1: To retrieve all the stream records from a shard
The following example retrieves all the stream records from a shard.
$result = $client->getRecords([ 'ShardIterator' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ......', ]);
Result syntax:
[ 'NextShardIterator' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ......', 'Records' => [ [ 'awsRegion' => 'us-west-2', 'dynamodb' => [ 'ApproximateCreationDateTime' => , 'Keys' => [ 'ForumName' => [ 'S' => 'DynamoDB', ], 'Subject' => [ 'S' => 'DynamoDB Thread 3', ], ], 'SequenceNumber' => '300000000000000499659', 'SizeBytes' => 41, 'StreamViewType' => 'KEYS_ONLY', ], 'eventID' => 'e2fd9c34eff2d779b297b26f5fef4206', 'eventName' => 'INSERT', 'eventSource' => 'aws:dynamodb', 'eventVersion' => '1.0', ], [ 'awsRegion' => 'us-west-2', 'dynamodb' => [ 'ApproximateCreationDateTime' => , 'Keys' => [ 'ForumName' => [ 'S' => 'DynamoDB', ], 'Subject' => [ 'S' => 'DynamoDB Thread 1', ], ], 'SequenceNumber' => '400000000000000499660', 'SizeBytes' => 41, 'StreamViewType' => 'KEYS_ONLY', ], 'eventID' => '4b25bd0da9a181a155114127e4837252', 'eventName' => 'MODIFY', 'eventSource' => 'aws:dynamodb', 'eventVersion' => '1.0', ], [ 'awsRegion' => 'us-west-2', 'dynamodb' => [ 'ApproximateCreationDateTime' => , 'Keys' => [ 'ForumName' => [ 'S' => 'DynamoDB', ], 'Subject' => [ 'S' => 'DynamoDB Thread 2', ], ], 'SequenceNumber' => '500000000000000499661', 'SizeBytes' => 41, 'StreamViewType' => 'KEYS_ONLY', ], 'eventID' => '740280c73a3df7842edab3548a1b08ad', 'eventName' => 'REMOVE', 'eventSource' => 'aws:dynamodb', 'eventVersion' => '1.0', ], ], ]
GetShardIterator
$result = $client->getShardIterator
([/* ... */]); $promise = $client->getShardIteratorAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getShardIterator([ 'SequenceNumber' => '<string>', 'ShardId' => '<string>', // REQUIRED 'ShardIteratorType' => 'TRIM_HORIZON|LATEST|AT_SEQUENCE_NUMBER|AFTER_SEQUENCE_NUMBER', // REQUIRED 'StreamArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SequenceNumber
-
- Type: string
The sequence number of a stream record in the shard from which to start reading.
- ShardId
-
- Required: Yes
- Type: string
The identifier of the shard. The iterator will be returned for this shard ID.
- ShardIteratorType
-
- Required: Yes
- Type: string
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.
- StreamArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the stream.
Result Syntax
[ 'ShardIterator' => '<string>', ]
Result Details
Members
- ShardIterator
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.- InternalServerError:
An error occurred on the server side.
- TrimmedDataAccessException:
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.
-
Examples
Example 1: To obtain a shard iterator for the provided stream ARN and shard ID
The following example returns a shard iterator for the provided stream ARN and shard ID.
$result = $client->getShardIterator([ 'ShardId' => '00000001414576573621-f55eea83', 'ShardIteratorType' => 'TRIM_HORIZON', 'StreamArn' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252', ]);
Result syntax:
[ 'ShardIterator' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ......', ]
ListStreams
$result = $client->listStreams
([/* ... */]); $promise = $client->listStreamsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listStreams([ 'ExclusiveStartStreamArn' => '<string>', 'Limit' => <integer>, 'TableName' => '<string>', ]);
Parameter Details
Members
- ExclusiveStartStreamArn
-
- Type: string
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. - Limit
-
- Type: int
The maximum number of streams to return. The upper limit is 100.
- TableName
-
- Type: string
If this parameter is provided, then only the streams associated with this table name are returned.
Result Syntax
[ 'LastEvaluatedStreamArn' => '<string>', 'Streams' => [ [ 'StreamArn' => '<string>', 'StreamLabel' => '<string>', 'TableName' => '<string>', ], // ... ], ]
Result Details
Members
- LastEvaluatedStreamArn
-
- Type: string
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 whenLastEvaluatedStreamArn
is empty. - Streams
-
- Type: Array of Stream structures
A list of stream descriptors associated with the current account and endpoint.
Errors
- ResourceNotFoundException:
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.- InternalServerError:
An error occurred on the server side.
Examples
Example 1: To list all of the stream ARNs
The following example lists all of the stream ARNs.
$result = $client->listStreams([ ]);
Result syntax:
[ 'Streams' => [ [ 'StreamArn' => 'arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252', 'StreamLabel' => '2015-05-20T20:51:10.252', 'TableName' => 'Forum', ], [ 'StreamArn' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714', 'StreamLabel' => '2015-05-20T20:50:02.714', 'TableName' => 'Forum', ], [ 'StreamArn' => 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641', 'StreamLabel' => '2015-05-19T23:03:50.641', 'TableName' => 'Forum', ], ], ]
Shapes
AttributeValue
Description
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.
Members
- B
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
An attribute of type Binary. For example:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
- BOOL
-
- Type: boolean
An attribute of type Boolean. For example:
"BOOL": true
- BS
-
- Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s
An attribute of type Binary Set. For example:
"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
- L
-
- Type: Array of AttributeValue structures
An attribute of type List. For example:
"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]
- M
-
- Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures
An attribute of type Map. For example:
"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
- N
-
- Type: string
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.
- NS
-
- Type: Array of strings
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.
- NULL
-
- Type: boolean
An attribute of type Null. For example:
"NULL": true
- S
-
- Type: string
An attribute of type String. For example:
"S": "Hello"
- SS
-
- Type: Array of strings
An attribute of type String Set. For example:
"SS": ["Giraffe", "Hippo" ,"Zebra"]
ExpiredIteratorException
Description
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.
Members
- message
-
- Type: string
The provided iterator exceeds the maximum age allowed.
Identity
Description
Contains details about the type of identity that made the request.
Members
- PrincipalId
-
- Type: string
A unique identifier for the entity that made the call. For Time To Live, the principalId is "dynamodb.amazonaws.com".
- Type
-
- Type: string
The type of the identity. For Time To Live, the type is "Service".
InternalServerError
Description
An error occurred on the server side.
Members
- message
-
- Type: string
The server encountered an internal error trying to fulfill the request.
KeySchemaElement
Description
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.
Members
- AttributeName
-
- Required: Yes
- Type: string
The name of a key attribute.
- KeyType
-
- Required: Yes
- Type: string
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.
LimitExceededException
Description
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.
Members
- message
-
- Type: string
Too many operations for a given subscriber.
Record
Description
A description of a unique event within a stream.
Members
- awsRegion
-
- Type: string
The region in which the
GetRecords
request was received. - dynamodb
-
- Type: StreamRecord structure
The main body of the stream record, containing all of the DynamoDB-specific fields.
- eventID
-
- Type: string
A globally unique identifier for the event that was recorded in this stream record.
- eventName
-
- Type: string
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
- eventSource
-
- Type: string
The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is
aws:dynamodb
. - eventVersion
-
- Type: string
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. - userIdentity
-
- Type: Identity structure
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"
ResourceNotFoundException
Description
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE
.
Members
- message
-
- Type: string
The resource which is being requested does not exist.
SequenceNumberRange
Description
The beginning and ending sequence numbers for the stream records contained within a shard.
Members
- EndingSequenceNumber
-
- Type: string
The last sequence number for the stream records contained within a shard. String contains numeric characters only.
- StartingSequenceNumber
-
- Type: string
The first sequence number for the stream records contained within a shard. String contains numeric characters only.
Shard
Description
A uniquely identified group of stream records within a stream.
Members
- ParentShardId
-
- Type: string
The shard ID of the current shard's parent.
- SequenceNumberRange
-
- Type: SequenceNumberRange structure
The range of possible sequence numbers for the shard.
- ShardId
-
- Type: string
The system-generated identifier for this shard.
Stream
Description
Represents all of the data describing a particular stream.
Members
- StreamArn
-
- Type: string
The Amazon Resource Name (ARN) for the stream.
- StreamLabel
-
- Type: string
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
- TableName
-
- Type: string
The DynamoDB table with which the stream is associated.
StreamDescription
Description
Represents all of the data describing a particular stream.
Members
- CreationRequestDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the request to create this stream was issued.
- KeySchema
-
- Type: Array of KeySchemaElement structures
The key attribute(s) of the stream's DynamoDB table.
- LastEvaluatedShardId
-
- Type: string
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 whenLastEvaluatedShardId
is empty. - Shards
-
- Type: Array of Shard structures
The shards that comprise the stream.
- StreamArn
-
- Type: string
The Amazon Resource Name (ARN) for the stream.
- StreamLabel
-
- Type: string
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
- StreamStatus
-
- Type: string
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.
- StreamViewType
-
- Type: string
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.
- TableName
-
- Type: string
The DynamoDB table with which the stream is associated.
StreamRecord
Description
A description of a single data modification that was performed on an item in a DynamoDB table.
Members
- ApproximateCreationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second.
- Keys
-
- Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures
The primary key attribute(s) for the DynamoDB item that was modified.
- NewImage
-
- Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures
The item in the DynamoDB table as it appeared after it was modified.
- OldImage
-
- Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures
The item in the DynamoDB table as it appeared before it was modified.
- SequenceNumber
-
- Type: string
The sequence number of the stream record.
- SizeBytes
-
- Type: long (int|float)
The size of the stream record, in bytes.
- StreamViewType
-
- Type: string
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.
TrimmedDataAccessException
Description
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.
Members
- message
-
- Type: string
"The data you are trying to access has been trimmed.