Aws.DynamoDb.Streams.Commands.DescribeStream

Request

data DescribeStream

Constructors

DescribeStream

Fields

_dstExclusiveStartShardId :: !(Maybe ShardId)

The shard id of the first item this operation will evalute; see also _sdLastEvaluatedShardId.

_dstLimit :: !(Maybe Int)

The maximum number of shard objects to return.

_dstStreamId :: !StreamId

The unique ID of the stream to be described.

Instances

Eq DescribeStream

Ord DescribeStream

Read DescribeStream

Show DescribeStream

ToJSON DescribeStream

FromJSON DescribeStream

SignQuery DescribeStream

Typeable * DescribeStream

Transaction DescribeStream DescribeStreamResponse

IteratedTransaction DescribeStream DescribeStreamResponse

type ServiceConfiguration DescribeStream = StreamsConfiguration

describeStream :: StreamId -> DescribeStream

A basic DescribeStream request for a given stream id.

myRequest =
  describeStream myStream
    & dstLimit ?~ 3

Lenses

dstExclusiveStartShardId :: Functor f => (Maybe ShardId -> f (Maybe ShardId)) -> DescribeStream -> f DescribeStream

A lens for _dstExclusiveStartShardId.

dstExclusiveStartShardId ∷ Lens' DescribeStream (Maybe ShardId)

dstLimit :: Functor f => (Maybe Int -> f (Maybe Int)) -> DescribeStream -> f DescribeStream

A lens for _dstLimit.

dstLimit ∷ Lens' DescribeStream (Maybe Int)

dstStreamId :: Functor f => (StreamId -> f StreamId) -> DescribeStream -> f DescribeStream

A lens for _dstStreamId.

dstStreamId ∷ Lens' DescribeStream StreamId

Response

data DescribeStreamResponse

Constructors

DescribeStreamResponse

Fields

_dstrStreamDescription :: !StreamDescription

Instances

Eq DescribeStreamResponse

Ord DescribeStreamResponse

Read DescribeStreamResponse

Show DescribeStreamResponse

ToJSON DescribeStreamResponse

FromJSON DescribeStreamResponse

AsMemoryResponse DescribeStreamResponse

Typeable * DescribeStreamResponse

ResponseConsumer r DescribeStreamResponse

ListResponse DescribeStreamResponse Shard

Transaction DescribeStream DescribeStreamResponse

IteratedTransaction DescribeStream DescribeStreamResponse

type ResponseMetadata DescribeStreamResponse = StreamsMetadata

type MemoryResponse DescribeStreamResponse = DescribeStreamResponse

Lenses

dstrStreamDescription :: Functor f => (StreamDescription -> f StreamDescription) -> DescribeStreamResponse -> f DescribeStreamResponse

A lens for _dstrStreamDescription.

dstrStreamDescription ∷ Lens' DescribeStreamResponse StreamDescription