Class: Aws::Kinesis::Types::ShardFilter

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass ShardFilter data as a hash:

{
  type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
  shard_id: "ShardId",
  timestamp: Time.now,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#shard_idString

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

Returns:

  • (String)

1973
1974
1975
1976
1977
1978
1979
# File 'lib/aws-sdk-kinesis/types.rb', line 1973

class ShardFilter < Struct.new(
  :type,
  :shard_id,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#timestampTime

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.

Returns:

  • (Time)

1973
1974
1975
1976
1977
1978
1979
# File 'lib/aws-sdk-kinesis/types.rb', line 1973

class ShardFilter < Struct.new(
  :type,
  :shard_id,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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.

Returns:

  • (String)

1973
1974
1975
1976
1977
1978
1979
# File 'lib/aws-sdk-kinesis/types.rb', line 1973

class ShardFilter < Struct.new(
  :type,
  :shard_id,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end