Network.AWS.DynamoDBStreams.DescribeStream

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.

You can call DescribeStream at a maximum rate of 10 times per second.

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, the that shared is closed and can no longer receive more data.

See: AWS API Reference for DescribeStream.

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
• dsLimit
• dsStreamARN

data DescribeStream

Represents the input of a DescribeStream operation.

See: describeStream smart constructor.

Instances

Eq DescribeStream

Data DescribeStream

Read DescribeStream

Show DescribeStream

Generic DescribeStream

ToJSON DescribeStream

AWSRequest DescribeStream

ToPath DescribeStream

ToHeaders DescribeStream

ToQuery DescribeStream

Typeable * DescribeStream

type Rep 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

dsrsStatus

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

data DescribeStreamResponse

Represents the output of a DescribeStream operation.

See: describeStreamResponse smart constructor.

Instances

Eq DescribeStreamResponse

Data DescribeStreamResponse

Read DescribeStreamResponse

Show DescribeStreamResponse

Generic DescribeStreamResponse

Typeable * DescribeStreamResponse

type Rep DescribeStreamResponse

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.

dsrsStatus :: Lens' DescribeStreamResponse Int

The response status code.