API version 2012-08-10 of the Amazon DynamoDB Streams SDK configuration.

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.

An error occurred on the server side.

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.

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

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

Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

There is a soft account quota of 256 tables.

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.

See: newAttributeValue smart constructor.

Create a value of AttributeValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:l:AttributeValue', attributeValue_l - An attribute of type List. For example:

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

$sel:ns:AttributeValue', attributeValue_ns - 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.

$sel:m:AttributeValue', attributeValue_m - An attribute of type Map. For example:

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

$sel:null:AttributeValue', attributeValue_null - An attribute of type Null. For example:

"NULL": true

$sel:n:AttributeValue', attributeValue_n - 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.

$sel:bs:AttributeValue', attributeValue_bs - An attribute of type Binary Set. For example:

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

$sel:b:AttributeValue', attributeValue_b - An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:ss:AttributeValue', attributeValue_ss - An attribute of type String Set. For example:

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

$sel:s:AttributeValue', attributeValue_s - An attribute of type String. For example:

"S": "Hello"

$sel:bool:AttributeValue', attributeValue_bool - An attribute of type Boolean. For example:

"BOOL": true

An attribute of type List. For example:

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

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.

An attribute of type Map. For example:

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

An attribute of type Null. For example:

"NULL": true

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.

An attribute of type Binary Set. For example:

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

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

An attribute of type String Set. For example:

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

An attribute of type String. For example:

"S": "Hello"

An attribute of type Boolean. For example:

"BOOL": true

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

See: newIdentity smart constructor.

Create a value of Identity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:principalId:Identity', identity_principalId - A unique identifier for the entity that made the call. For Time To Live, the principalId is "dynamodb.amazonaws.com".

$sel:type':Identity', identity_type - The type of the identity. For Time To Live, the type is "Service".

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

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

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.

See: newKeySchemaElement smart constructor.

Create a value of KeySchemaElement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeName:KeySchemaElement', keySchemaElement_attributeName - The name of a key attribute.

$sel:keyType:KeySchemaElement', keySchemaElement_keyType - 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.

The name of a key attribute.

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.

A description of a unique event within a stream.

See: newRecord smart constructor.

Create a value of Record with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userIdentity:Record', 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"

$sel:eventVersion: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.

$sel:dynamodb:Record', record_dynamodb - The main body of the stream record, containing all of the DynamoDB-specific fields.

$sel:awsRegion:Record', record_awsRegion - The region in which the GetRecords request was received.

$sel:eventName:Record', 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

$sel:eventSource:Record', record_eventSource - The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

$sel:eventID:Record', record_eventID - A globally unique identifier for the event that was recorded in this stream record.

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"

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 main body of the stream record, containing all of the DynamoDB-specific fields.

The region in which the GetRecords request was received.

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 AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

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

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

See: newSequenceNumberRange smart constructor.

Create a value of SequenceNumberRange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:startingSequenceNumber:SequenceNumberRange', sequenceNumberRange_startingSequenceNumber - The first sequence number for the stream records contained within a shard. String contains numeric characters only.

$sel:endingSequenceNumber:SequenceNumberRange', sequenceNumberRange_endingSequenceNumber - The last sequence number for the stream records contained within a shard. String contains numeric characters only.

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

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

A uniquely identified group of stream records within a stream.

See: newShard smart constructor.

Create a value of Shard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:parentShardId:Shard', shard_parentShardId - The shard ID of the current shard's parent.

$sel:sequenceNumberRange:Shard', shard_sequenceNumberRange - The range of possible sequence numbers for the shard.

$sel:shardId:Shard', shard_shardId - The system-generated identifier for this shard.

The shard ID of the current shard's parent.

The range of possible sequence numbers for the shard.

The system-generated identifier for this shard.

Represents all of the data describing a particular stream.

See: newStream smart constructor.

Create a value of Stream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamLabel:Stream', stream_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

$sel:streamArn:Stream', stream_streamArn - The Amazon Resource Name (ARN) for the stream.

$sel:tableName:Stream', stream_tableName - The DynamoDB table with which the stream is associated.

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

The Amazon Resource Name (ARN) for the stream.

The DynamoDB table with which the stream is associated.

Represents all of the data describing a particular stream.

See: newStreamDescription smart constructor.

Create a value of StreamDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lastEvaluatedShardId:StreamDescription', 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.

$sel:streamLabel:StreamDescription', streamDescription_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

$sel:streamStatus:StreamDescription', 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.

$sel:keySchema:StreamDescription', streamDescription_keySchema - The key attribute(s) of the stream's DynamoDB table.

$sel:streamViewType:StreamDescription', streamDescription_streamViewType - 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.

$sel:streamArn:StreamDescription', streamDescription_streamArn - The Amazon Resource Name (ARN) for the stream.

$sel:shards:StreamDescription', streamDescription_shards - The shards that comprise the stream.

$sel:tableName:StreamDescription', streamDescription_tableName - The DynamoDB table with which the stream is associated.

$sel:creationRequestDateTime:StreamDescription', streamDescription_creationRequestDateTime - The date and time when the request to create this stream was issued.

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 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

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.

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

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 Amazon Resource Name (ARN) for the stream.

The shards that comprise the stream.

The DynamoDB table with which the stream is associated.

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

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

See: newStreamRecord smart constructor.