Network.AWS.Kinesis.DescribeStream

Describes the specified Amazon Kinesis stream.

The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about 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. A sequence number is the identifier associated with every record ingested in the stream. The sequence number is assigned when a record is put into the stream.

You can limit the number of returned shards using the Limit parameter. The number of shards in a stream may be too large to return from a single call to DescribeStream. You can detect this by using the HasMoreShards flag in the returned output. HasMoreShards is set to true when there is more data available.

DescribeStream is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream.

There are no guarantees about the chronological order shards returned in DescribeStream results. If you want to process shards in chronological order, use ParentShardId to track lineage to the oldest shard.

DescribeStream has a limit of 10 transactions per second per account.

This operation returns paginated results.

Creating a Request

describeStream

Arguments

:: Text

dStreamName

-> 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
• dLimit
• dStreamName

data DescribeStream

Represents the input for DescribeStream.

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 -> ()

AWSPager DescribeStream

Methods

page :: DescribeStream -> Rs DescribeStream -> Maybe 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.Kinesis.DescribeStream" "amazonka-kinesis-1.4.1-JKMseqtqhHCCnc3IBujcO8" 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

type Rs DescribeStream = DescribeStreamResponse

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.

dStreamName :: Lens' DescribeStream Text

The name of the stream to describe.

Destructuring the Response

describeStreamResponse

Arguments

:: Int

dsrsResponseStatus

-> StreamDescription

dsrsStreamDescription

-> 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
• dsrsStreamDescription

data DescribeStreamResponse

Represents the output for DescribeStream.

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.Kinesis.DescribeStream" "amazonka-kinesis-1.4.1-JKMseqtqhHCCnc3IBujcO8" False) (C1 (MetaCons "DescribeStreamResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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 states whether there are more shards available.