| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Kinesis.DescribeStream
Description
Describes the specified Kinesis data stream.
This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis data stream and the ListShards API to list the shards in a specified data stream and obtain information about each shard.
When invoking this API, it is recommended you use the StreamARN input
parameter rather than the StreamName input parameter.
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 Data 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
- data DescribeStream = DescribeStream' {}
- newDescribeStream :: DescribeStream
- describeStream_exclusiveStartShardId :: Lens' DescribeStream (Maybe Text)
- describeStream_limit :: Lens' DescribeStream (Maybe Natural)
- describeStream_streamARN :: Lens' DescribeStream (Maybe Text)
- describeStream_streamName :: Lens' DescribeStream (Maybe Text)
- data DescribeStreamResponse = DescribeStreamResponse' {}
- newDescribeStreamResponse :: Int -> StreamDescription -> DescribeStreamResponse
- describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int
- describeStreamResponse_streamDescription :: Lens' DescribeStreamResponse StreamDescription
Creating a Request
data DescribeStream Source #
Represents the input for DescribeStream.
See: newDescribeStream smart constructor.
Constructors
| DescribeStream' | |
Fields
| |
Instances
newDescribeStream :: DescribeStream Source #
Create a value of DescribeStream with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveStartShardId:DescribeStream', describeStream_exclusiveStartShardId - The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the stream
starting with the shard whose ID immediately follows
ExclusiveStartShardId.
If you don't specify this parameter, the default behavior for
DescribeStream is to describe the stream starting with the first shard
in the stream.
$sel:limit:DescribeStream', describeStream_limit - 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
results are returned.
DescribeStream, describeStream_streamARN - The ARN of the stream.
DescribeStream, describeStream_streamName - The name of the stream to describe.
Request Lenses
describeStream_exclusiveStartShardId :: Lens' DescribeStream (Maybe Text) Source #
The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the stream
starting with the shard whose ID immediately follows
ExclusiveStartShardId.
If you don't specify this parameter, the default behavior for
DescribeStream is to describe the stream starting with the first shard
in the stream.
describeStream_limit :: Lens' DescribeStream (Maybe Natural) Source #
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 results are returned.
describeStream_streamARN :: Lens' DescribeStream (Maybe Text) Source #
The ARN of the stream.
describeStream_streamName :: Lens' DescribeStream (Maybe Text) Source #
The name of the stream to describe.
Destructuring the Response
data DescribeStreamResponse Source #
Represents the output for DescribeStream.
See: newDescribeStreamResponse smart constructor.
Constructors
| DescribeStreamResponse' | |
Fields
| |
Instances
newDescribeStreamResponse Source #
Arguments
| :: Int | |
| -> StreamDescription | |
| -> DescribeStreamResponse |
Create a value of DescribeStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeStreamResponse', describeStreamResponse_httpStatus - The response's http status code.
$sel:streamDescription:DescribeStreamResponse', describeStreamResponse_streamDescription - The current status of the stream, the stream Amazon Resource Name (ARN),
an array of shard objects that comprise the stream, and whether there
are more shards available.
Response Lenses
describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int Source #
The response's http status code.
describeStreamResponse_streamDescription :: Lens' DescribeStreamResponse StreamDescription Source #
The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.