edit-icon download-icon

DescribeStream

Last Updated: Mar 23, 2018

Action:

DescribeStream obtains information about the shards of the current stream.

Note: Data reading for the parent shard must be completed before data of the current shard is read.

Request structure:

  1. message DescribeStreamRequest {
  2. required string stream_id = 1;
  3. optional string inclusive_start_shard_id = 2;
  4. optional int32 shard_limit = 3;
  5. }

stream_id:

  • Type: required string

  • The ID of the current stream.

inclusive_start_shard_id:

  • Type: required string

  • The ID of the start shard in a query.

shard_limit:

  • Type: required string

  • The upper limit of the returned shard quantity in a single query.

Response message structure:

  1. message DescribeStreamResponse {
  2. required string stream_id = 1;
  3. required int32 expiration_time = 2;
  4. required string table_name = 3;
  5. required int64 creation_time = 4;
  6. required StreamStatus stream_status = 5;
  7. repeated StreamShard shards = 6;
  8. optional string next_shard_id = 7;
  9. }
  10. message StreamShard {
  11. required string shard_id = 1;
  12. optional string parent_id = 2;
  13. optional string parent_sibling_id = 3;
  14. }

stream_id:

  • Type: required string

  • The ID of the current stream.

expiration_time:

  • Type: required int32

  • The expiration time of the stream.

table_name:

  • Type: required string

  • The name of the table for which the current stream is enabled.

creation_time:

  • Type: required int32

  • The time when the current stream is enabled.

stream_status:

  • Type: required StreamStatus

  • The status of the current stream, which can be enabling or active.

shards:

  • Type: required StreamShard

  • The information about the streamShard, including the shard ID, parent shard ID, and information about the neighbor shard of the parent shard (applicable when the parent shard is merged).

next_shard_id:

  • Type: optional string

  • The start ID of the next shard in a paging query.

Thank you! We've received your feedback.