Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445336.6 KB

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

post/#X-Amz-Target=DynamoDBStreams_20120810.DescribeStream

Headers

X-Amz-Target'DynamoDBStreams_20120810.DescribeStream' required

Request body

StreamArnstring required

The Amazon Resource Name (ARN) for the stream.

Limitinteger

The maximum number of shard objects to return. The upper limit is 100.

ExclusiveStartShardIdstring

The shard ID of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedShardId</code> in the previous operation.

Response

Success

Example response

{
  "StreamDescription": {
    "CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015",
    "KeySchema": [
      {
        "AttributeName": "ForumName",
        "KeyType": "HASH"
      },
      {
        "AttributeName": "Subject",
        "KeyType": "RANGE"
      }
    ],
    "Shards": [
      {
        "SequenceNumberRange": {
          "EndingSequenceNumber": "20500000000000000910398",
          "StartingSequenceNumber": "20500000000000000910398"
        },
        "ShardId": "shardId-00000001414562045508-2bac9cd2"
      },
      {
        "ParentShardId": "shardId-00000001414562045508-2bac9cd2",
        "SequenceNumberRange": {
          "EndingSequenceNumber": "820400000000000001192334",
          "StartingSequenceNumber": "820400000000000001192334"
        },
        "ShardId": "shardId-00000001414576573621-f55eea83"
      },
      {
        "ParentShardId": "shardId-00000001414576573621-f55eea83",
        "SequenceNumberRange": {
          "EndingSequenceNumber": "1683700000000000001135967",
          "StartingSequenceNumber": "1683700000000000001135967"
        },
        "ShardId": "shardId-00000001414592258131-674fd923"
      },
      {
        "ParentShardId": "shardId-00000001414592258131-674fd923",
        "SequenceNumberRange": {
          "StartingSequenceNumber": "2574600000000000000935255"
        },
        "ShardId": "shardId-00000001414608446368-3a1afbaf"
      }
    ],
    "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
    "StreamLabel": "2015-05-20T20:51:10.252",
    "StreamStatus": "ENABLED",
    "StreamViewType": "NEW_AND_OLD_IMAGES",
    "TableName": "Forum"
  }
}
All 4 operations