amazonka-dynamodb-streams-1.4.5: Amazon DynamoDB Streams SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DynamoDBStreams.GetRecords

Contents

Description

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.

Synopsis

Creating a Request

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 - The maximum number of records to return from the shard. The upper limit is 1000.
  • grShardIterator - A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

data GetRecords #

Represents the input of a GetRecords operation.

See: getRecords smart constructor.

Instances

Eq GetRecords # 
Data GetRecords # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetRecords -> c GetRecords #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetRecords #

toConstr :: GetRecords -> Constr #

dataTypeOf :: GetRecords -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetRecords) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetRecords) #

gmapT :: (forall b. Data b => b -> b) -> GetRecords -> GetRecords #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetRecords -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetRecords -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetRecords -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetRecords -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetRecords -> m GetRecords #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRecords -> m GetRecords #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRecords -> m GetRecords #

Read GetRecords # 
Show GetRecords # 
Generic GetRecords # 

Associated Types

type Rep GetRecords :: * -> * #

Hashable GetRecords # 
ToJSON GetRecords # 
NFData GetRecords # 

Methods

rnf :: GetRecords -> () #

AWSRequest GetRecords # 
ToQuery GetRecords # 
ToPath GetRecords # 
ToHeaders GetRecords # 

Methods

toHeaders :: GetRecords -> [Header] #

type Rep GetRecords # 
type Rep GetRecords = D1 (MetaData "GetRecords" "Network.AWS.DynamoDBStreams.GetRecords" "amazonka-dynamodb-streams-1.4.5-1JUgl1lmZkS649OJ57ZQdS" False) (C1 (MetaCons "GetRecords'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_grLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_grShardIterator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetRecords # 

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 #

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 - The stream records from the shard, which were retrieved using the shard iterator.
  • grrsNextShardIterator - 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.
  • grrsResponseStatus - -- | The response status code.

data GetRecordsResponse #

Represents the output of a GetRecords operation.

See: getRecordsResponse smart constructor.

Instances

Eq GetRecordsResponse # 
Data GetRecordsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetRecordsResponse -> c GetRecordsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetRecordsResponse #

toConstr :: GetRecordsResponse -> Constr #

dataTypeOf :: GetRecordsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetRecordsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetRecordsResponse) #

gmapT :: (forall b. Data b => b -> b) -> GetRecordsResponse -> GetRecordsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetRecordsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetRecordsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetRecordsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetRecordsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetRecordsResponse -> m GetRecordsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRecordsResponse -> m GetRecordsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRecordsResponse -> m GetRecordsResponse #

Read GetRecordsResponse # 
Show GetRecordsResponse # 
Generic GetRecordsResponse # 
NFData GetRecordsResponse # 

Methods

rnf :: GetRecordsResponse -> () #

type Rep GetRecordsResponse # 
type Rep GetRecordsResponse = D1 (MetaData "GetRecordsResponse" "Network.AWS.DynamoDBStreams.GetRecords" "amazonka-dynamodb-streams-1.4.5-1JUgl1lmZkS649OJ57ZQdS" False) (C1 (MetaCons "GetRecordsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_grrsRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Record]))) ((:*:) (S1 (MetaSel (Just Symbol "_grrsNextShardIterator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_grrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

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.

grrsResponseStatus :: Lens' GetRecordsResponse Int #

  • - | The response status code.