amazonka-kinesis-1.4.5: Amazon Kinesis 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.Kinesis.DescribeStream

Contents

Description

Describes the specified Amazon Kinesis stream.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Streams Developer Guide .

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

This operation returns paginated results.

Synopsis

Creating a Request

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:

  • dExclusiveStartShardId - The shard ID of the shard to start with.
  • dLimit - The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.
  • dStreamName - The name of the stream to describe.

data DescribeStream #

Represents the input for DescribeStream .

See: describeStream smart constructor.

Instances

Eq DescribeStream # 
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 # 
Show DescribeStream # 
Generic DescribeStream # 

Associated Types

type Rep DescribeStream :: * -> * #

Hashable DescribeStream # 
ToJSON DescribeStream # 
NFData DescribeStream # 

Methods

rnf :: DescribeStream -> () #

AWSPager DescribeStream # 
AWSRequest DescribeStream # 
ToQuery DescribeStream # 
ToPath DescribeStream # 
ToHeaders DescribeStream # 
type Rep DescribeStream # 
type Rep DescribeStream = D1 (MetaData "DescribeStream" "Network.AWS.Kinesis.DescribeStream" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "DescribeStream'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dExclusiveStartShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeStream # 

Request Lenses

dExclusiveStartShardId :: Lens' DescribeStream (Maybe Text) #

The shard ID of the shard to start with.

dLimit :: Lens' DescribeStream (Maybe Natural) #

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

dStreamName :: Lens' DescribeStream Text #

The name of the stream to describe.

Destructuring the Response

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:

  • dsrsResponseStatus - -- | The response status code.
  • dsrsStreamDescription - The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and whether there are more shards available.

data DescribeStreamResponse #

Represents the output for DescribeStream .

See: describeStreamResponse smart constructor.

Instances

Eq DescribeStreamResponse # 
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 # 
Show DescribeStreamResponse # 
Generic DescribeStreamResponse # 
NFData DescribeStreamResponse # 

Methods

rnf :: DescribeStreamResponse -> () #

type Rep DescribeStreamResponse # 
type Rep DescribeStreamResponse = D1 (MetaData "DescribeStreamResponse" "Network.AWS.Kinesis.DescribeStream" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "DescribeStreamResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_dsrsStreamDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StreamDescription))))

Response Lenses

dsrsResponseStatus :: Lens' DescribeStreamResponse Int #

  • - | The response status code.

dsrsStreamDescription :: Lens' DescribeStreamResponse StreamDescription #

The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and whether there are more shards available.