Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.DynamoDBStreams.GetShardIterator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

getShardIterator Source #

Arguments

:: Text	`gsiStreamARN`
-> Text	`gsiShardId`
-> ShardIteratorType	`gsiShardIteratorType`
-> GetShardIterator

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

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

gsiSequenceNumber - The sequence number of a stream record in the shard from which to start reading.
gsiStreamARN - The Amazon Resource Name (ARN) for the stream.
gsiShardId - The identifier of the shard. The iterator will be returned for this shard ID.
gsiShardIteratorType - 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.

data GetShardIterator Source #

Represents the input of a GetShardIterator operation.

See: getShardIterator smart constructor.

Instances

Eq GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods (==) :: GetShardIterator -> GetShardIterator -> Bool # (/=) :: GetShardIterator -> GetShardIterator -> Bool #
Data GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetShardIterator -> c GetShardIterator # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetShardIterator # toConstr :: GetShardIterator -> Constr # dataTypeOf :: GetShardIterator -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetShardIterator) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetShardIterator) # gmapT :: (forall b. Data b => b -> b) -> GetShardIterator -> GetShardIterator # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetShardIterator -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetShardIterator -> r # gmapQ :: (forall d. Data d => d -> u) -> GetShardIterator -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetShardIterator -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetShardIterator -> m GetShardIterator # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetShardIterator -> m GetShardIterator # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetShardIterator -> m GetShardIterator #
Read GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods readsPrec :: Int -> ReadS GetShardIterator # readList :: ReadS [GetShardIterator] # readPrec :: ReadPrec GetShardIterator # readListPrec :: ReadPrec [GetShardIterator] #
Show GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods showsPrec :: Int -> GetShardIterator -> ShowS # show :: GetShardIterator -> String # showList :: [GetShardIterator] -> ShowS #
Generic GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Associated Types type Rep GetShardIterator :: Type -> Type # Methods from :: GetShardIterator -> Rep GetShardIterator x # to :: Rep GetShardIterator x -> GetShardIterator #
Hashable GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods hashWithSalt :: Int -> GetShardIterator -> Int # hash :: GetShardIterator -> Int #
ToJSON GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods toJSON :: GetShardIterator -> Value # toEncoding :: GetShardIterator -> Encoding # toJSONList :: [GetShardIterator] -> Value # toEncodingList :: [GetShardIterator] -> Encoding #
AWSRequest GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Associated Types type Rs GetShardIterator :: Type # Methods request :: GetShardIterator -> Request GetShardIterator # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetShardIterator -> ClientResponse -> m (Response GetShardIterator) #
ToHeaders GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods toHeaders :: GetShardIterator -> [Header] #
ToPath GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods toPath :: GetShardIterator -> ByteString #
ToQuery GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods toQuery :: GetShardIterator -> QueryString #
NFData GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods rnf :: GetShardIterator -> () #
type Rep GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator type Rep GetShardIterator = D1 (MetaData "GetShardIterator" "Network.AWS.DynamoDBStreams.GetShardIterator" "amazonka-dynamodb-streams-1.6.1-2ClpCrcoAn25PSx22S21t0" False) (C1 (MetaCons "GetShardIterator'" PrefixI True) ((S1 (MetaSel (Just "_gsiSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gsiStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_gsiShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_gsiShardIteratorType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ShardIteratorType))))
type Rs GetShardIterator Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator type Rs GetShardIterator = GetShardIteratorResponse

Request Lenses

gsiSequenceNumber :: Lens' GetShardIterator (Maybe Text) Source #

The sequence number of a stream record in the shard from which to start reading.

gsiStreamARN :: Lens' GetShardIterator Text Source #

The Amazon Resource Name (ARN) for the stream.

gsiShardId :: Lens' GetShardIterator Text Source #

The identifier of the shard. The iterator will be returned for this shard ID.

gsiShardIteratorType :: Lens' GetShardIterator ShardIteratorType Source #

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.

Destructuring the Response

getShardIteratorResponse Source #

Arguments

:: Int	`gsirsResponseStatus`
-> GetShardIteratorResponse

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

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

gsirsShardIterator - 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.
gsirsResponseStatus - -- | The response status code.

data GetShardIteratorResponse Source #

Represents the output of a GetShardIterator operation.

See: getShardIteratorResponse smart constructor.

Instances

Eq GetShardIteratorResponse Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods (==) :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool # (/=) :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool #
Data GetShardIteratorResponse Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetShardIteratorResponse -> c GetShardIteratorResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetShardIteratorResponse # toConstr :: GetShardIteratorResponse -> Constr # dataTypeOf :: GetShardIteratorResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetShardIteratorResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetShardIteratorResponse) # gmapT :: (forall b. Data b => b -> b) -> GetShardIteratorResponse -> GetShardIteratorResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetShardIteratorResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetShardIteratorResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetShardIteratorResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetShardIteratorResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetShardIteratorResponse -> m GetShardIteratorResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetShardIteratorResponse -> m GetShardIteratorResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetShardIteratorResponse -> m GetShardIteratorResponse #
Read GetShardIteratorResponse Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods readsPrec :: Int -> ReadS GetShardIteratorResponse # readList :: ReadS [GetShardIteratorResponse] # readPrec :: ReadPrec GetShardIteratorResponse # readListPrec :: ReadPrec [GetShardIteratorResponse] #
Show GetShardIteratorResponse Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods showsPrec :: Int -> GetShardIteratorResponse -> ShowS # show :: GetShardIteratorResponse -> String # showList :: [GetShardIteratorResponse] -> ShowS #
Generic GetShardIteratorResponse Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Associated Types type Rep GetShardIteratorResponse :: Type -> Type # Methods from :: GetShardIteratorResponse -> Rep GetShardIteratorResponse x # to :: Rep GetShardIteratorResponse x -> GetShardIteratorResponse #
NFData GetShardIteratorResponse Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator Methods rnf :: GetShardIteratorResponse -> () #
type Rep GetShardIteratorResponse Source #
Instance details Defined in Network.AWS.DynamoDBStreams.GetShardIterator type Rep GetShardIteratorResponse = D1 (MetaData "GetShardIteratorResponse" "Network.AWS.DynamoDBStreams.GetShardIterator" "amazonka-dynamodb-streams-1.6.1-2ClpCrcoAn25PSx22S21t0" False) (C1 (MetaCons "GetShardIteratorResponse'" PrefixI True) (S1 (MetaSel (Just "_gsirsShardIterator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gsirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

gsirsShardIterator :: Lens' GetShardIteratorResponse (Maybe Text) Source #

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.

gsirsResponseStatus :: Lens' GetShardIteratorResponse Int Source #

- | The response status code.