Stream

An Amazon Kinesis data stream.

AnalyticsBig DataData ProcessingReal-TimeStreaming

Properties

Name	Type	Description
StreamName	string	The name of the stream.
StreamARN	string	The Amazon Resource Name (ARN) for the stream.
StreamStatus	string	The current status.
RetentionPeriodHours	integer	The current retention period, in hours.
StreamCreationTimestamp	string	The approximate time the stream was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-kinesis/refs/heads/main/json-schema/amazon-kinesis-stream-schema.json",
  "title": "Stream",
  "description": "An Amazon Kinesis data stream.",
  "type": "object",
  "properties": {
    "StreamName": {
      "type": "string",
      "description": "The name of the stream.",
      "example": "my-data-stream"
    },
    "StreamARN": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) for the stream."
    },
    "StreamStatus": {
      "type": "string",
      "description": "The current status.",
      "example": "ACTIVE",
      "enum": [
        "CREATING",
        "DELETING",
        "ACTIVE",
        "UPDATING"
      ]
    },
    "RetentionPeriodHours": {
      "type": "integer",
      "description": "The current retention period, in hours.",
      "example": 24
    },
    "StreamCreationTimestamp": {
      "type": "string",
      "description": "The approximate time the stream was created.",
      "format": "date-time"
    }
  }
}