Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kinesis.Types.ShardFilter

Description

Synopsis

data ShardFilter = ShardFilter' {
- shardId :: Maybe Text
- timestamp :: Maybe POSIX
- type' :: ShardFilterType
}
newShardFilter :: ShardFilterType -> ShardFilter
shardFilter_shardId :: Lens' ShardFilter (Maybe Text)
shardFilter_timestamp :: Lens' ShardFilter (Maybe UTCTime)
shardFilter_type :: Lens' ShardFilter ShardFilterType

Documentation

data ShardFilter Source #

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

See: newShardFilter smart constructor.

Constructors

ShardFilter'

Fields

shardId :: Maybe Text
The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
timestamp :: Maybe POSIX
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' :: ShardFilterType
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.

Instances

Instances details

ToJSON ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods toJSON :: ShardFilter -> Value # toEncoding :: ShardFilter -> Encoding # toJSONList :: [ShardFilter] -> Value # toEncodingList :: [ShardFilter] -> Encoding #
Generic ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Associated Types type Rep ShardFilter :: Type -> Type # Methods from :: ShardFilter -> Rep ShardFilter x # to :: Rep ShardFilter x -> ShardFilter #
Read ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods readsPrec :: Int -> ReadS ShardFilter # readList :: ReadS [ShardFilter] # readPrec :: ReadPrec ShardFilter # readListPrec :: ReadPrec [ShardFilter] #
Show ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods showsPrec :: Int -> ShardFilter -> ShowS # show :: ShardFilter -> String # showList :: [ShardFilter] -> ShowS #
NFData ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods rnf :: ShardFilter -> () #
Eq ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods (==) :: ShardFilter -> ShardFilter -> Bool # (/=) :: ShardFilter -> ShardFilter -> Bool #
Hashable ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods hashWithSalt :: Int -> ShardFilter -> Int # hash :: ShardFilter -> Int #
type Rep ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter type Rep ShardFilter = D1 ('MetaData "ShardFilter" "Amazonka.Kinesis.Types.ShardFilter" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "ShardFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShardFilterType))))

newShardFilter Source #

Arguments

:: ShardFilterType	`$sel:type':ShardFilter'`
-> ShardFilter

Create a value of ShardFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shardId:ShardFilter', shardFilter_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.

$sel:timestamp:ShardFilter', shardFilter_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.

$sel:type':ShardFilter', shardFilter_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.

shardFilter_shardId :: Lens' ShardFilter (Maybe Text) Source #

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

shardFilter_timestamp :: Lens' ShardFilter (Maybe UTCTime) Source #

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.

shardFilter_type :: Lens' ShardFilter ShardFilterType Source #

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.