Method: Aws::Kinesis::Client#describe_stream

Defined in:

lib/aws-sdk-kinesis/client.rb

#describe_stream(params = {}) ⇒ Types::DescribeStreamOutput

Describes the specified Kinesis data stream.

<note markdown=“1”> 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.

</note>

<note markdown=“1”> When invoking this API, you must use either the ‘StreamARN` or the `StreamName` parameter, or both. It is recommended that you use the `StreamARN` input parameter when you invoke this API.

</note>

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.

[1]: docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* stream_exists
* stream_not_exists

Examples:

Request syntax with placeholder values

resp = client.describe_stream({
  stream_name: "StreamName",
  limit: 1,
  exclusive_start_shard_id: "ShardId",
  stream_arn: "StreamARN",
})

Response structure

resp.stream_description.stream_name #=> String
resp.stream_description.stream_arn #=> String
resp.stream_description.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
resp.stream_description.stream_mode_details.stream_mode #=> String, one of "PROVISIONED", "ON_DEMAND"
resp.stream_description.shards #=> Array
resp.stream_description.shards[0].shard_id #=> String
resp.stream_description.shards[0].parent_shard_id #=> String
resp.stream_description.shards[0].adjacent_parent_shard_id #=> String
resp.stream_description.shards[0].hash_key_range.starting_hash_key #=> String
resp.stream_description.shards[0].hash_key_range.ending_hash_key #=> String
resp.stream_description.shards[0].sequence_number_range.starting_sequence_number #=> String
resp.stream_description.shards[0].sequence_number_range.ending_sequence_number #=> String
resp.stream_description.has_more_shards #=> Boolean
resp.stream_description.retention_period_hours #=> Integer
resp.stream_description.stream_creation_timestamp #=> Time
resp.stream_description.enhanced_monitoring #=> Array
resp.stream_description.enhanced_monitoring[0].shard_level_metrics #=> Array
resp.stream_description.enhanced_monitoring[0].shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
resp.stream_description.encryption_type #=> String, one of "NONE", "KMS"
resp.stream_description.key_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :stream_name (String) —

  The name of the stream to describe.

• :limit (Integer) —

  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.

• :exclusive_start_shard_id (String) —

  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.

• :stream_arn (String) —

  The ARN of the stream.

Returns:

• (Types::DescribeStreamOutput) —

  Returns a response object which responds to the following methods:

  • #stream_description => Types::StreamDescription

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-kinesis/client.rb', line 971

def describe_stream(params = {}, options = {})
  req = build_request(:describe_stream, params)
  req.send_request(options)
end