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

Network.AWS.DynamoDBStreams.DescribeStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber , then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.

Creating a Request

describeStream #

Arguments

:: Text	`dsStreamARN`
-> DescribeStream

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

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

dsExclusiveStartShardId - The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.
dsLimit - The maximum number of shard objects to return. The upper limit is 100.
dsStreamARN - The Amazon Resource Name (ARN) for the stream.

data DescribeStream #

Represents the input of a DescribeStream operation.

See: describeStream smart constructor.

Instances

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

Request Lenses

dsExclusiveStartShardId :: Lens' DescribeStream (Maybe Text) #

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

dsLimit :: Lens' DescribeStream (Maybe Natural) #

The maximum number of shard objects to return. The upper limit is 100.

dsStreamARN :: Lens' DescribeStream Text #

The Amazon Resource Name (ARN) for the stream.

Destructuring the Response

describeStreamResponse #

Arguments

:: Int	`dsrsResponseStatus`
-> DescribeStreamResponse

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

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

dsrsStreamDescription - 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.
dsrsResponseStatus - -- | The response status code.

data DescribeStreamResponse #

Represents the output of a DescribeStream operation.

See: describeStreamResponse smart constructor.

Instances

Eq DescribeStreamResponse #
Methods (==) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool # (/=) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool #
Data DescribeStreamResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStreamResponse -> c DescribeStreamResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStreamResponse # toConstr :: DescribeStreamResponse -> Constr # dataTypeOf :: DescribeStreamResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStreamResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStreamResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeStreamResponse -> DescribeStreamResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeStreamResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStreamResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStreamResponse -> m DescribeStreamResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamResponse -> m DescribeStreamResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamResponse -> m DescribeStreamResponse #
Read DescribeStreamResponse #
Methods readsPrec :: Int -> ReadS DescribeStreamResponse # readList :: ReadS [DescribeStreamResponse] # readPrec :: ReadPrec DescribeStreamResponse # readListPrec :: ReadPrec [DescribeStreamResponse] #
Show DescribeStreamResponse #
Methods showsPrec :: Int -> DescribeStreamResponse -> ShowS # show :: DescribeStreamResponse -> String # showList :: [DescribeStreamResponse] -> ShowS #
Generic DescribeStreamResponse #
Associated Types type Rep DescribeStreamResponse :: * -> * # Methods from :: DescribeStreamResponse -> Rep DescribeStreamResponse x # to :: Rep DescribeStreamResponse x -> DescribeStreamResponse #
NFData DescribeStreamResponse #
Methods rnf :: DescribeStreamResponse -> () #
type Rep DescribeStreamResponse #
type Rep DescribeStreamResponse = D1 (MetaData "DescribeStreamResponse" "Network.AWS.DynamoDBStreams.DescribeStream" "amazonka-dynamodb-streams-1.4.5-1JUgl1lmZkS649OJ57ZQdS" False) (C1 (MetaCons "DescribeStreamResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dsrsStreamDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StreamDescription))) (S1 (MetaSel (Just Symbol "_dsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

dsrsStreamDescription :: Lens' DescribeStreamResponse (Maybe 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.

dsrsResponseStatus :: Lens' DescribeStreamResponse Int #

- | The response status code.