ShardFilter
The request parameter used to filter out the response of the ListShards
API.
Contents
- Type
-
The shard type specified in the
ShardFilterparameter. This is a required property of theShardFilterparameter.You can specify the following valid values:
-
AFTER_SHARD_ID- the response includes all the shards, starting with the shard whose ID immediately follows theShardIdthat you provided. -
AT_TRIM_HORIZON- the response includes all the shards that were open atTRIM_HORIZON. -
FROM_TRIM_HORIZON- (default), the response includes all the shards within the retention period of the data stream (trim to tip). -
AT_LATEST- the response includes only the currently open shards of the data stream. -
AT_TIMESTAMP- the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open. -
FROM_TIMESTAMP- the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected toTRIM_HORIZONof the data stream ifFROM_TIMESTAMPis less than theTRIM_HORIZONvalue.
Type: String
Valid Values:
AFTER_SHARD_ID | AT_TRIM_HORIZON | FROM_TRIM_HORIZON | AT_LATEST | AT_TIMESTAMP | FROM_TIMESTAMPRequired: Yes
-
- ShardId
-
The exclusive start
shardIDspeified in theShardFilterparameter. This property can only be used if theAFTER_SHARD_IDshard type is specified.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+Required: No
- Timestamp
-
The timestamps specified in the
ShardFilterparameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used ifFROM_TIMESTAMPorAT_TIMESTAMPshard types are specified.Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
