AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The request parameter used to filter out the response of the ListShards API.

Inheritance Hierarchy

System.Object
  Amazon.Kinesis.Model.ShardFilter

Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z

Syntax

C# 
public class ShardFilter

The ShardFilter type exposes the following members

Constructors

NameDescription
Public Method ShardFilter()

Properties

NameTypeDescription
Public Property ShardId System.String

Gets and sets the property ShardId.

The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.

Public Property Timestamp System.DateTime

Gets and sets the property Timestamp.

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.

Public Property Type Amazon.Kinesis.ShardFilterType

Gets and sets the property Type.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5