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 input of a GetShardIterator operation.

See: newGetShardIterator smart constructor.

Create a value of GetShardIterator 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:sequenceNumber:GetShardIterator', getShardIterator_sequenceNumber - The sequence number of a stream record in the shard from which to start reading.

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

$sel:shardId:GetShardIterator', getShardIterator_shardId - The identifier of the shard. The iterator will be returned for this shard ID.

$sel:shardIteratorType:GetShardIterator', getShardIterator_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 the output of a GetShardIterator operation.

See: newGetShardIteratorResponse smart constructor.

Create a value of GetShardIteratorResponse 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:shardIterator:GetShardIteratorResponse', getShardIteratorResponse_shardIterator - 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.

$sel:httpStatus:GetShardIteratorResponse', getShardIteratorResponse_httpStatus - The response's http status code.

Represents the input of a GetRecords operation.

See: newGetRecords smart constructor.

Create a value of GetRecords 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:limit:GetRecords', getRecords_limit - The maximum number of records to return from the shard. The upper limit is 1000.

$sel:shardIterator:GetRecords', getRecords_shardIterator - 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 output of a GetRecords operation.

See: newGetRecordsResponse smart constructor.

Create a value of GetRecordsResponse 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:records:GetRecordsResponse', getRecordsResponse_records - The stream records from the shard, which were retrieved using the shard iterator.

$sel:nextShardIterator:GetRecordsResponse', getRecordsResponse_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.

$sel:httpStatus:GetRecordsResponse', getRecordsResponse_httpStatus - The response's http status code.

Represents the input of a ListStreams operation.

See: newListStreams smart constructor.

Create a value of ListStreams 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:exclusiveStartStreamArn:ListStreams', listStreams_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.

$sel:limit:ListStreams', listStreams_limit - The maximum number of streams to return. The upper limit is 100.

$sel:tableName:ListStreams', listStreams_tableName - If this parameter is provided, then only the streams associated with this table name are returned.

Represents the output of a ListStreams operation.

See: newListStreamsResponse smart constructor.

Create a value of ListStreamsResponse 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:lastEvaluatedStreamArn:ListStreamsResponse', listStreamsResponse_lastEvaluatedStreamArn - 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.

$sel:streams:ListStreamsResponse', listStreamsResponse_streams - A list of stream descriptors associated with the current account and endpoint.

$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.

Represents the input of a DescribeStream operation.

See: newDescribeStream smart constructor.

Create a value of DescribeStream 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:exclusiveStartShardId:DescribeStream', describeStream_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.

$sel:limit:DescribeStream', describeStream_limit - The maximum number of shard objects to return. The upper limit is 100.

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

Represents the output of a DescribeStream operation.

See: newDescribeStreamResponse smart constructor.

Create a value of DescribeStreamResponse 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:streamDescription:DescribeStreamResponse', describeStreamResponse_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.

$sel:httpStatus:DescribeStreamResponse', describeStreamResponse_httpStatus - The response's http status code.

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

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

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.