The request parameter used to filter out the response of the ListShards
API.
The shard type specified in the ShardFilter
parameter. This is a required property of the ShardFilter
parameter.
You can specify the following valid values:
AFTER_SHARD_ID
- the response includes all the shards, starting with the shard whose ID immediately follows the ShardId
that you provided.
AT_TRIM_HORIZON
- the response includes all the shards that were open at TRIM_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 to TRIM_HORIZON
of the data stream if FROM_TIMESTAMP
is less than the TRIM_HORIZON
value.
Type: String
Valid Values: AFTER_SHARD_ID | AT_TRIM_HORIZON | FROM_TRIM_HORIZON | AT_LATEST | AT_TIMESTAMP | FROM_TIMESTAMP
Required: Yes
The exclusive start shardID
speified in the ShardFilter
parameter. This property can only be used if the AFTER_SHARD_ID
shard type is specified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9_.-]+
Required: No
The timestamps specified in the ShardFilter
parameter. 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 if FROM_TIMESTAMP
or AT_TIMESTAMP
shard types are specified.
Type: Timestamp
Required: No
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4