Network.AWS.DynamoDBStreams.GetRecords

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 2000 stream records, whichever comes first.

See: AWS API Reference for GetRecords.

Creating a Request

getRecords

Arguments

:: Text

grShardIterator

-> GetRecords

Creates a value of GetRecords with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• grLimit
• grShardIterator

data GetRecords

Represents the input of a GetRecords operation.

See: getRecords smart constructor.

Instances

Eq GetRecords

Data GetRecords

Read GetRecords

Show GetRecords

Generic GetRecords

ToJSON GetRecords

AWSRequest GetRecords

ToPath GetRecords

ToHeaders GetRecords

ToQuery GetRecords

Typeable * GetRecords

type Rep GetRecords

type Rs GetRecords = GetRecordsResponse

Request Lenses

grLimit :: Lens' GetRecords (Maybe Natural)

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

grShardIterator :: Lens' GetRecords Text

A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

Destructuring the Response

getRecordsResponse

Arguments

:: Int

grrsStatus

-> GetRecordsResponse

Creates a value of GetRecordsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• grrsRecords
• grrsNextShardIterator
• grrsStatus

data GetRecordsResponse

Represents the output of a GetRecords operation.

See: getRecordsResponse smart constructor.

Instances

Eq GetRecordsResponse

Data GetRecordsResponse

Read GetRecordsResponse

Show GetRecordsResponse

Generic GetRecordsResponse

Typeable * GetRecordsResponse

type Rep GetRecordsResponse

Response Lenses

grrsRecords :: Lens' GetRecordsResponse [Record]

The stream records from the shard, which were retrieved using the shard iterator.

grrsNextShardIterator :: Lens' GetRecordsResponse (Maybe Text)

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.

grrsStatus :: Lens' GetRecordsResponse Int

The response status code.