Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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

A shard iterator expires 15 minutes after it is returned to the requester.

Creating a Request

data GetShardIterator Source #

Represents the input of a GetShardIterator operation.

See: newGetShardIterator smart constructor.

Constructors

GetShardIterator'

Fields

sequenceNumber :: Maybe Text
The sequence number of a stream record in the shard from which to start reading.
streamArn :: Text
The Amazon Resource Name (ARN) for the stream.
shardId :: Text
The identifier of the shard. The iterator will be returned for this shard ID.
shardIteratorType :: 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.

Instances

Instances details

ToJSON GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods toJSON :: GetShardIterator -> Value # toEncoding :: GetShardIterator -> Encoding # toJSONList :: [GetShardIterator] -> Value # toEncodingList :: [GetShardIterator] -> Encoding #
ToHeaders GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods toHeaders :: GetShardIterator -> [Header] #
ToPath GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods toPath :: GetShardIterator -> ByteString #
ToQuery GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods toQuery :: GetShardIterator -> QueryString #
AWSRequest GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Associated Types type AWSResponse GetShardIterator # Methods request :: (Service -> Service) -> GetShardIterator -> Request GetShardIterator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetShardIterator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetShardIterator))) #
Generic GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Associated Types type Rep GetShardIterator :: Type -> Type # Methods from :: GetShardIterator -> Rep GetShardIterator x # to :: Rep GetShardIterator x -> GetShardIterator #
Read GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods readsPrec :: Int -> ReadS GetShardIterator # readList :: ReadS [GetShardIterator] # readPrec :: ReadPrec GetShardIterator # readListPrec :: ReadPrec [GetShardIterator] #
Show GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods showsPrec :: Int -> GetShardIterator -> ShowS # show :: GetShardIterator -> String # showList :: [GetShardIterator] -> ShowS #
NFData GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods rnf :: GetShardIterator -> () #
Eq GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods (==) :: GetShardIterator -> GetShardIterator -> Bool # (/=) :: GetShardIterator -> GetShardIterator -> Bool #
Hashable GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods hashWithSalt :: Int -> GetShardIterator -> Int # hash :: GetShardIterator -> Int #
type AWSResponse GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator type AWSResponse GetShardIterator = GetShardIteratorResponse
type Rep GetShardIterator Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator type Rep GetShardIterator = D1 ('MetaData "GetShardIterator" "Amazonka.DynamoDBStreams.GetShardIterator" "amazonka-dynamodb-streams-2.0-3efN0DbUklbJSr9bxtKOG6" 'False) (C1 ('MetaCons "GetShardIterator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shardIteratorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShardIteratorType))))

newGetShardIterator Source #

Arguments

:: Text	`GetShardIterator`
-> Text	`GetShardIterator`
-> ShardIteratorType	`$sel:shardIteratorType:GetShardIterator'`
-> GetShardIterator

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:

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

GetShardIterator, getShardIterator_streamArn - The Amazon Resource Name (ARN) for the stream.

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.

Request Lenses

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

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

getShardIterator_streamArn :: Lens' GetShardIterator Text Source #

The Amazon Resource Name (ARN) for the stream.

getShardIterator_shardId :: Lens' GetShardIterator Text Source #

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

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

data GetShardIteratorResponse Source #

Represents the output of a GetShardIterator operation.

See: newGetShardIteratorResponse smart constructor.

Constructors

GetShardIteratorResponse'
Fields shardIterator :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetShardIteratorResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Associated Types type Rep GetShardIteratorResponse :: Type -> Type # Methods from :: GetShardIteratorResponse -> Rep GetShardIteratorResponse x # to :: Rep GetShardIteratorResponse x -> GetShardIteratorResponse #
Read GetShardIteratorResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods readsPrec :: Int -> ReadS GetShardIteratorResponse # readList :: ReadS [GetShardIteratorResponse] # readPrec :: ReadPrec GetShardIteratorResponse # readListPrec :: ReadPrec [GetShardIteratorResponse] #
Show GetShardIteratorResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods showsPrec :: Int -> GetShardIteratorResponse -> ShowS # show :: GetShardIteratorResponse -> String # showList :: [GetShardIteratorResponse] -> ShowS #
NFData GetShardIteratorResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods rnf :: GetShardIteratorResponse -> () #
Eq GetShardIteratorResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator Methods (==) :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool # (/=) :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool #
type Rep GetShardIteratorResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.GetShardIterator type Rep GetShardIteratorResponse = D1 ('MetaData "GetShardIteratorResponse" "Amazonka.DynamoDBStreams.GetShardIterator" "amazonka-dynamodb-streams-2.0-3efN0DbUklbJSr9bxtKOG6" 'False) (C1 ('MetaCons "GetShardIteratorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shardIterator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetShardIteratorResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetShardIteratorResponse'`
-> GetShardIteratorResponse

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.

Response Lenses

getShardIteratorResponse_shardIterator :: 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.

getShardIteratorResponse_httpStatus :: Lens' GetShardIteratorResponse Int Source #

The response's http status code.