| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.AWS.Kinesis.Types
Contents
- data Kinesis
- data JSONError :: *
- data Shard
- shard :: Text -> HashKeyRange -> SequenceNumberRange -> Shard
- sAdjacentParentShardId :: Lens' Shard (Maybe Text)
- sHashKeyRange :: Lens' Shard HashKeyRange
- sParentShardId :: Lens' Shard (Maybe Text)
- sSequenceNumberRange :: Lens' Shard SequenceNumberRange
- sShardId :: Lens' Shard Text
- data Tag
- tag :: Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag (Maybe Text)
- data StreamDescription
- streamDescription :: Text -> Text -> StreamStatus -> Bool -> StreamDescription
- sdHasMoreShards :: Lens' StreamDescription Bool
- sdShards :: Lens' StreamDescription [Shard]
- sdStreamARN :: Lens' StreamDescription Text
- sdStreamName :: Lens' StreamDescription Text
- sdStreamStatus :: Lens' StreamDescription StreamStatus
- data StreamStatus
- data HashKeyRange
- hashKeyRange :: Text -> Text -> HashKeyRange
- hkrEndingHashKey :: Lens' HashKeyRange Text
- hkrStartingHashKey :: Lens' HashKeyRange Text
- data Record
- record :: Text -> Base64 -> Text -> Record
- rData :: Lens' Record Base64
- rPartitionKey :: Lens' Record Text
- rSequenceNumber :: Lens' Record Text
- data SequenceNumberRange
- sequenceNumberRange :: Text -> SequenceNumberRange
- snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)
- snrStartingSequenceNumber :: Lens' SequenceNumberRange Text
- data ShardIteratorType
Service
Version 2013-12-02 of the Amazon Kinesis service.
Error
data JSONError :: *
Shard
Arguments
| :: Text | |
| -> HashKeyRange | |
| -> SequenceNumberRange | |
| -> Shard |
Shard constructor.
The fields accessible through corresponding lenses are:
sAdjacentParentShardId :: Lens' Shard (Maybe Text) Source
The shard Id of the shard adjacent to the shard's parent.
sHashKeyRange :: Lens' Shard HashKeyRange Source
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
sSequenceNumberRange :: Lens' Shard SequenceNumberRange Source
The range of possible sequence numbers for the shard.
sShardId :: Lens' Shard Text Source
The unique identifier of the shard within the Amazon Kinesis stream.
Tag
tagKey :: Lens' Tag Text Source
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
tagValue :: Lens' Tag (Maybe Text) Source
An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
StreamDescription
data StreamDescription Source
Arguments
| :: Text | |
| -> Text | |
| -> StreamStatus | |
| -> Bool | |
| -> StreamDescription |
StreamDescription constructor.
The fields accessible through corresponding lenses are:
sdHasMoreShards :: Lens' StreamDescription Bool Source
If set to true, more shards in the stream are available to describe.
sdShards :: Lens' StreamDescription [Shard] Source
The shards that comprise the stream.
sdStreamARN :: Lens' StreamDescription Text Source
The Amazon Resource Name (ARN) for the stream being described.
sdStreamName :: Lens' StreamDescription Text Source
The name of the stream being described.
sdStreamStatus :: Lens' StreamDescription StreamStatus Source
The current status of the stream being described.
The stream status is one of the following states:
CREATING - The stream is being created. Amazon Kinesis immediately returns
and sets StreamStatus to CREATING. DELETING - The stream is being deleted.
The specified stream is in the DELETING state until Amazon Kinesis completes
the deletion. ACTIVE - The stream exists and is ready for read and write
operations or deletion. You should perform read and write operations only on
an ACTIVE stream. UPDATING - Shards in the stream are being merged or split.
Read and write operations continue to work while the stream is in the UPDATING
state.
StreamStatus
data StreamStatus Source
HashKeyRange
data HashKeyRange Source
Arguments
| :: Text | |
| -> Text | |
| -> HashKeyRange |
HashKeyRange constructor.
The fields accessible through corresponding lenses are:
hkrEndingHashKey :: Lens' HashKeyRange Text Source
The ending hash key of the hash key range.
hkrStartingHashKey :: Lens' HashKeyRange Text Source
The starting hash key of the hash key range.
Record
Record constructor.
The fields accessible through corresponding lenses are:
rData::Base64rPartitionKey::TextrSequenceNumber::Text
rData :: Lens' Record Base64 Source
The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. The maximum size of the data blob (the payload before Base64-encoding) is 50 kilobytes (KB)
rPartitionKey :: Lens' Record Text Source
Identifies which shard in the stream the data record is assigned to.
rSequenceNumber :: Lens' Record Text Source
The unique identifier for the record in the Amazon Kinesis stream.
SequenceNumberRange
Arguments
| :: Text | |
| -> SequenceNumberRange |
SequenceNumberRange constructor.
The fields accessible through corresponding lenses are:
snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text) Source
The ending sequence number for the range. Shards that are in the OPEN state
have an ending sequence number of null.
snrStartingSequenceNumber :: Lens' SequenceNumberRange Text Source
The starting sequence number for the range.
ShardIteratorType
data ShardIteratorType Source
Constructors
| AfterSequenceNumber | AFTER_SEQUENCE_NUMBER |
| AtSequenceNumber | AT_SEQUENCE_NUMBER |
| Latest | LATEST |
| TrimHorizon | TRIM_HORIZON |
Instances