ShardFilter
This optional field contains the filter
definition for the DescribeStream
API.
Contents
Note
In the following list, the required parameters are described first.
- ShardId
-
Contains the
shardId
of the parent shard for which you are requesting child shards.Sample request:
Type: String
Length Constraints: Minimum length of 28. Maximum length of 65.
Required: No
- Type
-
Contains the type of filter to be applied on the
DescribeStream
API. Currently, the only value this parameter accepts isCHILD_SHARDS
.Type: String
Valid Values:
CHILD_SHARDS
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: