AWS Kinesis · Schema
DescribeStreamInput
Represents the input for DescribeStream.
AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo
Properties
| Name | Type | Description |
|---|---|---|
| StreamName | object | |
| Limit | object | |
| ExclusiveStartShardId | object | |
| StreamARN | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/DescribeStreamInput",
"title": "DescribeStreamInput",
"type": "object",
"properties": {
"StreamName": {
"allOf": [
{
"$ref": "#/components/schemas/StreamName"
},
{
"description": "The name of the stream to describe."
}
]
},
"Limit": {
"allOf": [
{
"$ref": "#/components/schemas/DescribeStreamInputLimit"
},
{
"description": "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."
}
]
},
"ExclusiveStartShardId": {
"allOf": [
{
"$ref": "#/components/schemas/ShardId"
},
{
"description": "<p>The shard ID of the shard to start with.</p> <p>Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p> <p>If you don't specify this parameter, the default behavior for <code>DescribeStream</code> is to describe the stream starting with the first shard in the stream.</p>"
}
]
},
"StreamARN": {
"allOf": [
{
"$ref": "#/components/schemas/StreamARN"
},
{
"description": "The ARN of the stream."
}
]
}
},
"description": "Represents the input for <code>DescribeStream</code>."
}