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 |
- Operations
- AddTagsToStream
- CreateStream
- DecreaseStreamRetentionPeriod
- DeleteStream
- DeregisterStreamConsumer
- DescribeLimits
- DescribeStream
- DescribeStreamConsumer
- DescribeStreamSummary
- DisableEnhancedMonitoring
- EnableEnhancedMonitoring
- GetRecords
- GetShardIterator
- IncreaseStreamRetentionPeriod
- ListShards
- ListStreamConsumers
- ListStreams
- ListTagsForStream
- MergeShards
- PutRecord
- PutRecords
- RegisterStreamConsumer
- RemoveTagsFromStream
- SplitShard
- StartStreamEncryption
- StopStreamEncryption
- SubscribeToShard
- UpdateShardCount
- UpdateStreamMode
- Types
Synopsis
- addTagsToStream_streamARN :: Lens' AddTagsToStream (Maybe Text)
- addTagsToStream_streamName :: Lens' AddTagsToStream (Maybe Text)
- addTagsToStream_tags :: Lens' AddTagsToStream (HashMap Text Text)
- createStream_shardCount :: Lens' CreateStream (Maybe Natural)
- createStream_streamModeDetails :: Lens' CreateStream (Maybe StreamModeDetails)
- createStream_streamName :: Lens' CreateStream Text
- decreaseStreamRetentionPeriod_streamARN :: Lens' DecreaseStreamRetentionPeriod (Maybe Text)
- decreaseStreamRetentionPeriod_streamName :: Lens' DecreaseStreamRetentionPeriod (Maybe Text)
- decreaseStreamRetentionPeriod_retentionPeriodHours :: Lens' DecreaseStreamRetentionPeriod Int
- deleteStream_enforceConsumerDeletion :: Lens' DeleteStream (Maybe Bool)
- deleteStream_streamARN :: Lens' DeleteStream (Maybe Text)
- deleteStream_streamName :: Lens' DeleteStream (Maybe Text)
- deregisterStreamConsumer_consumerARN :: Lens' DeregisterStreamConsumer (Maybe Text)
- deregisterStreamConsumer_consumerName :: Lens' DeregisterStreamConsumer (Maybe Text)
- deregisterStreamConsumer_streamARN :: Lens' DeregisterStreamConsumer (Maybe Text)
- describeLimitsResponse_httpStatus :: Lens' DescribeLimitsResponse Int
- describeLimitsResponse_shardLimit :: Lens' DescribeLimitsResponse Natural
- describeLimitsResponse_openShardCount :: Lens' DescribeLimitsResponse Natural
- describeLimitsResponse_onDemandStreamCount :: Lens' DescribeLimitsResponse Natural
- describeLimitsResponse_onDemandStreamCountLimit :: Lens' DescribeLimitsResponse Natural
- describeStream_exclusiveStartShardId :: Lens' DescribeStream (Maybe Text)
- describeStream_limit :: Lens' DescribeStream (Maybe Natural)
- describeStream_streamARN :: Lens' DescribeStream (Maybe Text)
- describeStream_streamName :: Lens' DescribeStream (Maybe Text)
- describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int
- describeStreamResponse_streamDescription :: Lens' DescribeStreamResponse StreamDescription
- describeStreamConsumer_consumerARN :: Lens' DescribeStreamConsumer (Maybe Text)
- describeStreamConsumer_consumerName :: Lens' DescribeStreamConsumer (Maybe Text)
- describeStreamConsumer_streamARN :: Lens' DescribeStreamConsumer (Maybe Text)
- describeStreamConsumerResponse_httpStatus :: Lens' DescribeStreamConsumerResponse Int
- describeStreamConsumerResponse_consumerDescription :: Lens' DescribeStreamConsumerResponse ConsumerDescription
- describeStreamSummary_streamARN :: Lens' DescribeStreamSummary (Maybe Text)
- describeStreamSummary_streamName :: Lens' DescribeStreamSummary (Maybe Text)
- describeStreamSummaryResponse_httpStatus :: Lens' DescribeStreamSummaryResponse Int
- describeStreamSummaryResponse_streamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary
- disableEnhancedMonitoring_streamARN :: Lens' DisableEnhancedMonitoring (Maybe Text)
- disableEnhancedMonitoring_streamName :: Lens' DisableEnhancedMonitoring (Maybe Text)
- disableEnhancedMonitoring_shardLevelMetrics :: Lens' DisableEnhancedMonitoring [MetricsName]
- enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text)
- enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text)
- enableEnhancedMonitoring_streamARN :: Lens' EnableEnhancedMonitoring (Maybe Text)
- enableEnhancedMonitoring_streamName :: Lens' EnableEnhancedMonitoring (Maybe Text)
- enableEnhancedMonitoring_shardLevelMetrics :: Lens' EnableEnhancedMonitoring [MetricsName]
- enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text)
- enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text)
- getRecords_limit :: Lens' GetRecords (Maybe Natural)
- getRecords_streamARN :: Lens' GetRecords (Maybe Text)
- getRecords_shardIterator :: Lens' GetRecords Text
- getRecordsResponse_childShards :: Lens' GetRecordsResponse (Maybe [ChildShard])
- getRecordsResponse_millisBehindLatest :: Lens' GetRecordsResponse (Maybe Natural)
- getRecordsResponse_nextShardIterator :: Lens' GetRecordsResponse (Maybe Text)
- getRecordsResponse_httpStatus :: Lens' GetRecordsResponse Int
- getRecordsResponse_records :: Lens' GetRecordsResponse [Record]
- getShardIterator_startingSequenceNumber :: Lens' GetShardIterator (Maybe Text)
- getShardIterator_streamARN :: Lens' GetShardIterator (Maybe Text)
- getShardIterator_streamName :: Lens' GetShardIterator (Maybe Text)
- getShardIterator_timestamp :: Lens' GetShardIterator (Maybe UTCTime)
- getShardIterator_shardId :: Lens' GetShardIterator Text
- getShardIterator_shardIteratorType :: Lens' GetShardIterator ShardIteratorType
- getShardIteratorResponse_shardIterator :: Lens' GetShardIteratorResponse (Maybe Text)
- getShardIteratorResponse_httpStatus :: Lens' GetShardIteratorResponse Int
- increaseStreamRetentionPeriod_streamARN :: Lens' IncreaseStreamRetentionPeriod (Maybe Text)
- increaseStreamRetentionPeriod_streamName :: Lens' IncreaseStreamRetentionPeriod (Maybe Text)
- increaseStreamRetentionPeriod_retentionPeriodHours :: Lens' IncreaseStreamRetentionPeriod Int
- listShards_exclusiveStartShardId :: Lens' ListShards (Maybe Text)
- listShards_maxResults :: Lens' ListShards (Maybe Natural)
- listShards_nextToken :: Lens' ListShards (Maybe Text)
- listShards_shardFilter :: Lens' ListShards (Maybe ShardFilter)
- listShards_streamARN :: Lens' ListShards (Maybe Text)
- listShards_streamCreationTimestamp :: Lens' ListShards (Maybe UTCTime)
- listShards_streamName :: Lens' ListShards (Maybe Text)
- listShardsResponse_nextToken :: Lens' ListShardsResponse (Maybe Text)
- listShardsResponse_shards :: Lens' ListShardsResponse (Maybe [Shard])
- listShardsResponse_httpStatus :: Lens' ListShardsResponse Int
- listStreamConsumers_maxResults :: Lens' ListStreamConsumers (Maybe Natural)
- listStreamConsumers_nextToken :: Lens' ListStreamConsumers (Maybe Text)
- listStreamConsumers_streamCreationTimestamp :: Lens' ListStreamConsumers (Maybe UTCTime)
- listStreamConsumers_streamARN :: Lens' ListStreamConsumers Text
- listStreamConsumersResponse_consumers :: Lens' ListStreamConsumersResponse (Maybe [Consumer])
- listStreamConsumersResponse_nextToken :: Lens' ListStreamConsumersResponse (Maybe Text)
- listStreamConsumersResponse_httpStatus :: Lens' ListStreamConsumersResponse Int
- listStreams_exclusiveStartStreamName :: Lens' ListStreams (Maybe Text)
- listStreams_limit :: Lens' ListStreams (Maybe Natural)
- listStreams_nextToken :: Lens' ListStreams (Maybe Text)
- listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text)
- listStreamsResponse_streamSummaries :: Lens' ListStreamsResponse (Maybe [StreamSummary])
- listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int
- listStreamsResponse_streamNames :: Lens' ListStreamsResponse [Text]
- listStreamsResponse_hasMoreStreams :: Lens' ListStreamsResponse Bool
- listTagsForStream_exclusiveStartTagKey :: Lens' ListTagsForStream (Maybe Text)
- listTagsForStream_limit :: Lens' ListTagsForStream (Maybe Natural)
- listTagsForStream_streamARN :: Lens' ListTagsForStream (Maybe Text)
- listTagsForStream_streamName :: Lens' ListTagsForStream (Maybe Text)
- listTagsForStreamResponse_httpStatus :: Lens' ListTagsForStreamResponse Int
- listTagsForStreamResponse_tags :: Lens' ListTagsForStreamResponse [Tag]
- listTagsForStreamResponse_hasMoreTags :: Lens' ListTagsForStreamResponse Bool
- mergeShards_streamARN :: Lens' MergeShards (Maybe Text)
- mergeShards_streamName :: Lens' MergeShards (Maybe Text)
- mergeShards_shardToMerge :: Lens' MergeShards Text
- mergeShards_adjacentShardToMerge :: Lens' MergeShards Text
- putRecord_explicitHashKey :: Lens' PutRecord (Maybe Text)
- putRecord_sequenceNumberForOrdering :: Lens' PutRecord (Maybe Text)
- putRecord_streamARN :: Lens' PutRecord (Maybe Text)
- putRecord_streamName :: Lens' PutRecord (Maybe Text)
- putRecord_data :: Lens' PutRecord ByteString
- putRecord_partitionKey :: Lens' PutRecord Text
- putRecordResponse_encryptionType :: Lens' PutRecordResponse (Maybe EncryptionType)
- putRecordResponse_httpStatus :: Lens' PutRecordResponse Int
- putRecordResponse_shardId :: Lens' PutRecordResponse Text
- putRecordResponse_sequenceNumber :: Lens' PutRecordResponse Text
- putRecords_streamARN :: Lens' PutRecords (Maybe Text)
- putRecords_streamName :: Lens' PutRecords (Maybe Text)
- putRecords_records :: Lens' PutRecords (NonEmpty PutRecordsRequestEntry)
- putRecordsResponse_encryptionType :: Lens' PutRecordsResponse (Maybe EncryptionType)
- putRecordsResponse_failedRecordCount :: Lens' PutRecordsResponse (Maybe Natural)
- putRecordsResponse_httpStatus :: Lens' PutRecordsResponse Int
- putRecordsResponse_records :: Lens' PutRecordsResponse (NonEmpty PutRecordsResultEntry)
- registerStreamConsumer_streamARN :: Lens' RegisterStreamConsumer Text
- registerStreamConsumer_consumerName :: Lens' RegisterStreamConsumer Text
- registerStreamConsumerResponse_httpStatus :: Lens' RegisterStreamConsumerResponse Int
- registerStreamConsumerResponse_consumer :: Lens' RegisterStreamConsumerResponse Consumer
- removeTagsFromStream_streamARN :: Lens' RemoveTagsFromStream (Maybe Text)
- removeTagsFromStream_streamName :: Lens' RemoveTagsFromStream (Maybe Text)
- removeTagsFromStream_tagKeys :: Lens' RemoveTagsFromStream (NonEmpty Text)
- splitShard_streamARN :: Lens' SplitShard (Maybe Text)
- splitShard_streamName :: Lens' SplitShard (Maybe Text)
- splitShard_shardToSplit :: Lens' SplitShard Text
- splitShard_newStartingHashKey :: Lens' SplitShard Text
- startStreamEncryption_streamARN :: Lens' StartStreamEncryption (Maybe Text)
- startStreamEncryption_streamName :: Lens' StartStreamEncryption (Maybe Text)
- startStreamEncryption_encryptionType :: Lens' StartStreamEncryption EncryptionType
- startStreamEncryption_keyId :: Lens' StartStreamEncryption Text
- stopStreamEncryption_streamARN :: Lens' StopStreamEncryption (Maybe Text)
- stopStreamEncryption_streamName :: Lens' StopStreamEncryption (Maybe Text)
- stopStreamEncryption_encryptionType :: Lens' StopStreamEncryption EncryptionType
- stopStreamEncryption_keyId :: Lens' StopStreamEncryption Text
- subscribeToShard_consumerARN :: Lens' SubscribeToShard Text
- subscribeToShard_shardId :: Lens' SubscribeToShard Text
- subscribeToShard_startingPosition :: Lens' SubscribeToShard StartingPosition
- subscribeToShardResponse_httpStatus :: Lens' SubscribeToShardResponse Int
- subscribeToShardResponse_eventStream :: Lens' SubscribeToShardResponse Value
- updateShardCount_streamARN :: Lens' UpdateShardCount (Maybe Text)
- updateShardCount_streamName :: Lens' UpdateShardCount (Maybe Text)
- updateShardCount_targetShardCount :: Lens' UpdateShardCount Natural
- updateShardCount_scalingType :: Lens' UpdateShardCount ScalingType
- updateShardCountResponse_currentShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)
- updateShardCountResponse_streamARN :: Lens' UpdateShardCountResponse (Maybe Text)
- updateShardCountResponse_streamName :: Lens' UpdateShardCountResponse (Maybe Text)
- updateShardCountResponse_targetShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)
- updateShardCountResponse_httpStatus :: Lens' UpdateShardCountResponse Int
- updateStreamMode_streamARN :: Lens' UpdateStreamMode Text
- updateStreamMode_streamModeDetails :: Lens' UpdateStreamMode StreamModeDetails
- childShard_shardId :: Lens' ChildShard Text
- childShard_parentShards :: Lens' ChildShard [Text]
- childShard_hashKeyRange :: Lens' ChildShard HashKeyRange
- consumer_consumerName :: Lens' Consumer Text
- consumer_consumerARN :: Lens' Consumer Text
- consumer_consumerStatus :: Lens' Consumer ConsumerStatus
- consumer_consumerCreationTimestamp :: Lens' Consumer UTCTime
- consumerDescription_consumerName :: Lens' ConsumerDescription Text
- consumerDescription_consumerARN :: Lens' ConsumerDescription Text
- consumerDescription_consumerStatus :: Lens' ConsumerDescription ConsumerStatus
- consumerDescription_consumerCreationTimestamp :: Lens' ConsumerDescription UTCTime
- consumerDescription_streamARN :: Lens' ConsumerDescription Text
- enhancedMetrics_shardLevelMetrics :: Lens' EnhancedMetrics (Maybe [MetricsName])
- enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text)
- enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text)
- hashKeyRange_startingHashKey :: Lens' HashKeyRange Text
- hashKeyRange_endingHashKey :: Lens' HashKeyRange Text
- putRecordsRequestEntry_explicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)
- putRecordsRequestEntry_data :: Lens' PutRecordsRequestEntry ByteString
- putRecordsRequestEntry_partitionKey :: Lens' PutRecordsRequestEntry Text
- putRecordsResultEntry_errorCode :: Lens' PutRecordsResultEntry (Maybe Text)
- putRecordsResultEntry_errorMessage :: Lens' PutRecordsResultEntry (Maybe Text)
- putRecordsResultEntry_sequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text)
- putRecordsResultEntry_shardId :: Lens' PutRecordsResultEntry (Maybe Text)
- record_approximateArrivalTimestamp :: Lens' Record (Maybe UTCTime)
- record_encryptionType :: Lens' Record (Maybe EncryptionType)
- record_sequenceNumber :: Lens' Record Text
- record_data :: Lens' Record ByteString
- record_partitionKey :: Lens' Record Text
- sequenceNumberRange_endingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)
- sequenceNumberRange_startingSequenceNumber :: Lens' SequenceNumberRange Text
- shard_adjacentParentShardId :: Lens' Shard (Maybe Text)
- shard_parentShardId :: Lens' Shard (Maybe Text)
- shard_shardId :: Lens' Shard Text
- shard_hashKeyRange :: Lens' Shard HashKeyRange
- shard_sequenceNumberRange :: Lens' Shard SequenceNumberRange
- shardFilter_shardId :: Lens' ShardFilter (Maybe Text)
- shardFilter_timestamp :: Lens' ShardFilter (Maybe UTCTime)
- shardFilter_type :: Lens' ShardFilter ShardFilterType
- startingPosition_sequenceNumber :: Lens' StartingPosition (Maybe Text)
- startingPosition_timestamp :: Lens' StartingPosition (Maybe UTCTime)
- startingPosition_type :: Lens' StartingPosition ShardIteratorType
- streamDescription_encryptionType :: Lens' StreamDescription (Maybe EncryptionType)
- streamDescription_keyId :: Lens' StreamDescription (Maybe Text)
- streamDescription_streamModeDetails :: Lens' StreamDescription (Maybe StreamModeDetails)
- streamDescription_streamName :: Lens' StreamDescription Text
- streamDescription_streamARN :: Lens' StreamDescription Text
- streamDescription_streamStatus :: Lens' StreamDescription StreamStatus
- streamDescription_shards :: Lens' StreamDescription [Shard]
- streamDescription_hasMoreShards :: Lens' StreamDescription Bool
- streamDescription_retentionPeriodHours :: Lens' StreamDescription Int
- streamDescription_streamCreationTimestamp :: Lens' StreamDescription UTCTime
- streamDescription_enhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics]
- streamDescriptionSummary_consumerCount :: Lens' StreamDescriptionSummary (Maybe Natural)
- streamDescriptionSummary_encryptionType :: Lens' StreamDescriptionSummary (Maybe EncryptionType)
- streamDescriptionSummary_keyId :: Lens' StreamDescriptionSummary (Maybe Text)
- streamDescriptionSummary_streamModeDetails :: Lens' StreamDescriptionSummary (Maybe StreamModeDetails)
- streamDescriptionSummary_streamName :: Lens' StreamDescriptionSummary Text
- streamDescriptionSummary_streamARN :: Lens' StreamDescriptionSummary Text
- streamDescriptionSummary_streamStatus :: Lens' StreamDescriptionSummary StreamStatus
- streamDescriptionSummary_retentionPeriodHours :: Lens' StreamDescriptionSummary Int
- streamDescriptionSummary_streamCreationTimestamp :: Lens' StreamDescriptionSummary UTCTime
- streamDescriptionSummary_enhancedMonitoring :: Lens' StreamDescriptionSummary [EnhancedMetrics]
- streamDescriptionSummary_openShardCount :: Lens' StreamDescriptionSummary Natural
- streamModeDetails_streamMode :: Lens' StreamModeDetails StreamMode
- streamSummary_streamCreationTimestamp :: Lens' StreamSummary (Maybe UTCTime)
- streamSummary_streamModeDetails :: Lens' StreamSummary (Maybe StreamModeDetails)
- streamSummary_streamName :: Lens' StreamSummary Text
- streamSummary_streamARN :: Lens' StreamSummary Text
- streamSummary_streamStatus :: Lens' StreamSummary StreamStatus
- subscribeToShardEvent_childShards :: Lens' SubscribeToShardEvent (Maybe [ChildShard])
- subscribeToShardEvent_records :: Lens' SubscribeToShardEvent [Record]
- subscribeToShardEvent_continuationSequenceNumber :: Lens' SubscribeToShardEvent Text
- subscribeToShardEvent_millisBehindLatest :: Lens' SubscribeToShardEvent Natural
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
Operations
AddTagsToStream
addTagsToStream_streamARN :: Lens' AddTagsToStream (Maybe Text) Source #
The ARN of the stream.
addTagsToStream_streamName :: Lens' AddTagsToStream (Maybe Text) Source #
The name of the stream.
addTagsToStream_tags :: Lens' AddTagsToStream (HashMap Text Text) Source #
A set of up to 10 key-value pairs to use to create the tags.
CreateStream
createStream_shardCount :: Lens' CreateStream (Maybe Natural) Source #
The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
createStream_streamModeDetails :: Lens' CreateStream (Maybe StreamModeDetails) Source #
Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
createStream_streamName :: Lens' CreateStream Text Source #
A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services account but in two different Regions can also have the same name.
DecreaseStreamRetentionPeriod
decreaseStreamRetentionPeriod_streamARN :: Lens' DecreaseStreamRetentionPeriod (Maybe Text) Source #
The ARN of the stream.
decreaseStreamRetentionPeriod_streamName :: Lens' DecreaseStreamRetentionPeriod (Maybe Text) Source #
The name of the stream to modify.
decreaseStreamRetentionPeriod_retentionPeriodHours :: Lens' DecreaseStreamRetentionPeriod Int Source #
The new retention period of the stream, in hours. Must be less than the current retention period.
DeleteStream
deleteStream_enforceConsumerDeletion :: Lens' DeleteStream (Maybe Bool) Source #
If this parameter is unset (null
) or if you set it to false
, and the
stream has registered consumers, the call to DeleteStream
fails with a
ResourceInUseException
.
deleteStream_streamARN :: Lens' DeleteStream (Maybe Text) Source #
The ARN of the stream.
deleteStream_streamName :: Lens' DeleteStream (Maybe Text) Source #
The name of the stream to delete.
DeregisterStreamConsumer
deregisterStreamConsumer_consumerARN :: Lens' DeregisterStreamConsumer (Maybe Text) Source #
The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
deregisterStreamConsumer_consumerName :: Lens' DeregisterStreamConsumer (Maybe Text) Source #
The name that you gave to the consumer.
deregisterStreamConsumer_streamARN :: Lens' DeregisterStreamConsumer (Maybe Text) Source #
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
DescribeLimits
describeLimitsResponse_httpStatus :: Lens' DescribeLimitsResponse Int Source #
The response's http status code.
describeLimitsResponse_shardLimit :: Lens' DescribeLimitsResponse Natural Source #
The maximum number of shards.
describeLimitsResponse_openShardCount :: Lens' DescribeLimitsResponse Natural Source #
The number of open shards.
describeLimitsResponse_onDemandStreamCount :: Lens' DescribeLimitsResponse Natural Source #
Indicates the number of data streams with the on-demand capacity mode.
describeLimitsResponse_onDemandStreamCountLimit :: Lens' DescribeLimitsResponse Natural Source #
The maximum number of data streams with the on-demand capacity mode.
DescribeStream
describeStream_exclusiveStartShardId :: Lens' DescribeStream (Maybe Text) Source #
The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the stream
starting with the shard whose ID immediately follows
ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior for
DescribeStream
is to describe the stream starting with the first shard
in the stream.
describeStream_limit :: Lens' DescribeStream (Maybe Natural) Source #
The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
describeStream_streamARN :: Lens' DescribeStream (Maybe Text) Source #
The ARN of the stream.
describeStream_streamName :: Lens' DescribeStream (Maybe Text) Source #
The name of the stream to describe.
describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int Source #
The response's http status code.
describeStreamResponse_streamDescription :: Lens' DescribeStreamResponse StreamDescription Source #
The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.
DescribeStreamConsumer
describeStreamConsumer_consumerARN :: Lens' DescribeStreamConsumer (Maybe Text) Source #
The ARN returned by Kinesis Data Streams when you registered the consumer.
describeStreamConsumer_consumerName :: Lens' DescribeStreamConsumer (Maybe Text) Source #
The name that you gave to the consumer.
describeStreamConsumer_streamARN :: Lens' DescribeStreamConsumer (Maybe Text) Source #
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
describeStreamConsumerResponse_httpStatus :: Lens' DescribeStreamConsumerResponse Int Source #
The response's http status code.
describeStreamConsumerResponse_consumerDescription :: Lens' DescribeStreamConsumerResponse ConsumerDescription Source #
An object that represents the details of the consumer.
DescribeStreamSummary
describeStreamSummary_streamARN :: Lens' DescribeStreamSummary (Maybe Text) Source #
The ARN of the stream.
describeStreamSummary_streamName :: Lens' DescribeStreamSummary (Maybe Text) Source #
The name of the stream to describe.
describeStreamSummaryResponse_httpStatus :: Lens' DescribeStreamSummaryResponse Int Source #
The response's http status code.
describeStreamSummaryResponse_streamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary Source #
A StreamDescriptionSummary containing information about the stream.
DisableEnhancedMonitoring
disableEnhancedMonitoring_streamARN :: Lens' DisableEnhancedMonitoring (Maybe Text) Source #
The ARN of the stream.
disableEnhancedMonitoring_streamName :: Lens' DisableEnhancedMonitoring (Maybe Text) Source #
The name of the Kinesis data stream for which to disable enhanced monitoring.
disableEnhancedMonitoring_shardLevelMetrics :: Lens' DisableEnhancedMonitoring [MetricsName] Source #
List of shard-level metrics to disable.
The following are the valid shard-level metrics. The value "ALL
"
disables every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #
Represents the current state of the metrics that are in the enhanced state before the operation.
enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #
Represents the list of all the metrics that would be in the enhanced state after the operation.
enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #
The ARN of the stream.
enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #
The name of the Kinesis data stream.
EnableEnhancedMonitoring
enableEnhancedMonitoring_streamARN :: Lens' EnableEnhancedMonitoring (Maybe Text) Source #
The ARN of the stream.
enableEnhancedMonitoring_streamName :: Lens' EnableEnhancedMonitoring (Maybe Text) Source #
The name of the stream for which to enable enhanced monitoring.
enableEnhancedMonitoring_shardLevelMetrics :: Lens' EnableEnhancedMonitoring [MetricsName] Source #
List of shard-level metrics to enable.
The following are the valid shard-level metrics. The value "ALL
"
enables every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #
Represents the current state of the metrics that are in the enhanced state before the operation.
enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #
Represents the list of all the metrics that would be in the enhanced state after the operation.
enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #
The ARN of the stream.
enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #
The name of the Kinesis data stream.
GetRecords
getRecords_limit :: Lens' GetRecords (Maybe Natural) Source #
The maximum number of records to return. Specify a value of up to
10,000. If you specify a value that is greater than 10,000, GetRecords
throws InvalidArgumentException
. The default value is 10,000.
getRecords_streamARN :: Lens' GetRecords (Maybe Text) Source #
The ARN of the stream.
getRecords_shardIterator :: Lens' GetRecords Text Source #
The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
getRecordsResponse_childShards :: Lens' GetRecordsResponse (Maybe [ChildShard]) Source #
The list of the current shard's child shards, returned in the
GetRecords
API's response only when the end of the current shard is
reached.
getRecordsResponse_millisBehindLatest :: Lens' GetRecordsResponse (Maybe Natural) Source #
The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.
getRecordsResponse_nextShardIterator :: Lens' GetRecordsResponse (Maybe Text) Source #
The next position in the shard from which to start sequentially reading
data records. If set to null
, the shard has been closed and the
requested iterator does not return any more data.
getRecordsResponse_httpStatus :: Lens' GetRecordsResponse Int Source #
The response's http status code.
getRecordsResponse_records :: Lens' GetRecordsResponse [Record] Source #
The data records retrieved from the shard.
GetShardIterator
getShardIterator_startingSequenceNumber :: Lens' GetShardIterator (Maybe Text) Source #
The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
getShardIterator_streamARN :: Lens' GetShardIterator (Maybe Text) Source #
The ARN of the stream.
getShardIterator_streamName :: Lens' GetShardIterator (Maybe Text) Source #
The name of the Amazon Kinesis data stream.
getShardIterator_timestamp :: Lens' GetShardIterator (Maybe UTCTime) Source #
The time stamp of the data record from which to start reading. Used with
shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date
with precision in milliseconds. For example,
2016-04-04T19:58:46.480-00:00
or 1459799926.480
. If a record with
this exact time stamp does not exist, the iterator returned is for the
next (later) record. If the time stamp is older than the current trim
horizon, the iterator returned is for the oldest untrimmed data record
(TRIM_HORIZON).
getShardIterator_shardId :: Lens' GetShardIterator Text Source #
The shard ID of the Kinesis Data Streams shard to get the iterator for.
getShardIterator_shardIteratorType :: Lens' GetShardIterator ShardIteratorType Source #
Determines how the shard iterator is used to start reading data records from the shard.
The following are the valid Amazon Kinesis shard iterator types:
- AT_SEQUENCE_NUMBER - Start reading from the position denoted by a
specific sequence number, provided in the value
StartingSequenceNumber
. - AFTER_SEQUENCE_NUMBER - Start reading right after the position
denoted by a specific sequence number, provided in the value
StartingSequenceNumber
. - AT_TIMESTAMP - Start reading from the position denoted by a specific
time stamp, provided in the value
Timestamp
. - TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
- LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
getShardIteratorResponse_shardIterator :: Lens' GetShardIteratorResponse (Maybe Text) Source #
The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.
getShardIteratorResponse_httpStatus :: Lens' GetShardIteratorResponse Int Source #
The response's http status code.
IncreaseStreamRetentionPeriod
increaseStreamRetentionPeriod_streamARN :: Lens' IncreaseStreamRetentionPeriod (Maybe Text) Source #
The ARN of the stream.
increaseStreamRetentionPeriod_streamName :: Lens' IncreaseStreamRetentionPeriod (Maybe Text) Source #
The name of the stream to modify.
increaseStreamRetentionPeriod_retentionPeriodHours :: Lens' IncreaseStreamRetentionPeriod Int Source #
The new retention period of the stream, in hours. Must be more than the current retention period.
ListShards
listShards_exclusiveStartShardId :: Lens' ListShards (Maybe Text) Source #
Specify this parameter to indicate that you want to list the shards
starting with the shard whose ID immediately follows
ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for
ListShards
to list the shards starting with the first one in the
stream.
You cannot specify this parameter if you specify NextToken
.
listShards_maxResults :: Lens' ListShards (Maybe Natural) Source #
The maximum number of shards to return in a single call to ListShards
.
The maximum number of shards to return in a single call. The default
value is 1000. If you specify a value greater than 1000, at most 1000
results are returned.
When the number of shards to be listed is greater than the value of
MaxResults
, the response contains a NextToken
value that you can use
in a subsequent call to ListShards
to list the next set of shards.
listShards_nextToken :: Lens' ListShards (Maybe Text) Source #
When the number of shards in the data stream is greater than the default
value for the MaxResults
parameter, or if you explicitly specify a
value for MaxResults
that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken
.
You can specify this NextToken
value in a subsequent call to
ListShards
to list the next set of shards.
Don't specify StreamName
or StreamCreationTimestamp
if you specify
NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when
you specify NextToken
. If you specify a MaxResults
value that is
less than the number of shards that the operation returns if you don't
specify MaxResults
, the response will contain a new NextToken
value.
You can use the new NextToken
value in a subsequent call to the
ListShards
operation.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards
,
you get ExpiredNextTokenException
.
listShards_shardFilter :: Lens' ListShards (Maybe ShardFilter) Source #
Enables you to filter out the response of the ListShards
API. You can
only specify one filter at a time.
If you use the ShardFilter
parameter when invoking the ListShards API,
the Type
is the required property and must be specified. If you
specify the AT_TRIM_HORIZON
, FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the ShardId
or the
Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the
value for the optional ShardId
property. The ShardId
property is
identical in fuctionality to the ExclusiveStartShardId
parameter of
the ListShards
API. When ShardId
property is specified, the response
includes the shards starting with the shard whose ID immediately follows
the ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must
also provide the value for the optional Timestamp
property. If you
specify the AT_TIMESTAMP type, then all shards that were open at the
provided timestamp are returned. If you specify the FROM_TIMESTAMP type,
then all shards starting from the provided timestamp to TIP are
returned.
listShards_streamARN :: Lens' ListShards (Maybe Text) Source #
The ARN of the stream.
listShards_streamCreationTimestamp :: Lens' ListShards (Maybe UTCTime) Source #
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
listShards_streamName :: Lens' ListShards (Maybe Text) Source #
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
listShardsResponse_nextToken :: Lens' ListShardsResponse (Maybe Text) Source #
When the number of shards in the data stream is greater than the default
value for the MaxResults
parameter, or if you explicitly specify a
value for MaxResults
that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken
.
You can specify this NextToken
value in a subsequent call to
ListShards
to list the next set of shards. For more information about
the use of this pagination token when calling the ListShards
operation, see ListShardsInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards
,
you get ExpiredNextTokenException
.
listShardsResponse_shards :: Lens' ListShardsResponse (Maybe [Shard]) Source #
An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
listShardsResponse_httpStatus :: Lens' ListShardsResponse Int Source #
The response's http status code.
ListStreamConsumers
listStreamConsumers_maxResults :: Lens' ListStreamConsumers (Maybe Natural) Source #
The maximum number of consumers that you want a single call of
ListStreamConsumers
to return. The default value is 100. If you
specify a value greater than 100, at most 100 results are returned.
listStreamConsumers_nextToken :: Lens' ListStreamConsumers (Maybe Text) Source #
When the number of consumers that are registered with the data stream is
greater than the default value for the MaxResults
parameter, or if you
explicitly specify a value for MaxResults
that is less than the number
of consumers that are registered with the data stream, the response
includes a pagination token named NextToken
. You can specify this
NextToken
value in a subsequent call to ListStreamConsumers
to list
the next set of registered consumers.
Don't specify StreamName
or StreamCreationTimestamp
if you specify
NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when
you specify NextToken
. If you specify a MaxResults
value that is
less than the number of consumers that the operation returns if you
don't specify MaxResults
, the response will contain a new NextToken
value. You can use the new NextToken
value in a subsequent call to the
ListStreamConsumers
operation to list the next set of consumers.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListStreamConsumers
, you have 300 seconds
to use that value. If you specify an expired token in a call to
ListStreamConsumers
, you get ExpiredNextTokenException
.
listStreamConsumers_streamCreationTimestamp :: Lens' ListStreamConsumers (Maybe UTCTime) Source #
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.
You can't specify this parameter if you specify the NextToken parameter.
listStreamConsumers_streamARN :: Lens' ListStreamConsumers Text Source #
The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
listStreamConsumersResponse_consumers :: Lens' ListStreamConsumersResponse (Maybe [Consumer]) Source #
An array of JSON objects. Each object represents one registered consumer.
listStreamConsumersResponse_nextToken :: Lens' ListStreamConsumersResponse (Maybe Text) Source #
When the number of consumers that are registered with the data stream is
greater than the default value for the MaxResults
parameter, or if you
explicitly specify a value for MaxResults
that is less than the number
of registered consumers, the response includes a pagination token named
NextToken
. You can specify this NextToken
value in a subsequent call
to ListStreamConsumers
to list the next set of registered consumers.
For more information about the use of this pagination token when calling
the ListStreamConsumers
operation, see
ListStreamConsumersInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListStreamConsumers
, you have 300 seconds
to use that value. If you specify an expired token in a call to
ListStreamConsumers
, you get ExpiredNextTokenException
.
listStreamConsumersResponse_httpStatus :: Lens' ListStreamConsumersResponse Int Source #
The response's http status code.
ListStreams
listStreams_exclusiveStartStreamName :: Lens' ListStreams (Maybe Text) Source #
The name of the stream to start the list with.
listStreams_limit :: Lens' ListStreams (Maybe Natural) Source #
The maximum number of streams to list. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #
The response's http status code.
listStreamsResponse_streamNames :: Lens' ListStreamsResponse [Text] Source #
The names of the streams that are associated with the Amazon Web
Services account making the ListStreams
request.
listStreamsResponse_hasMoreStreams :: Lens' ListStreamsResponse Bool Source #
If set to true
, there are more streams available to list.
ListTagsForStream
listTagsForStream_exclusiveStartTagKey :: Lens' ListTagsForStream (Maybe Text) Source #
The key to use as the starting point for the list of tags. If this
parameter is set, ListTagsForStream
gets all tags that occur after
ExclusiveStartTagKey
.
listTagsForStream_limit :: Lens' ListTagsForStream (Maybe Natural) Source #
The number of tags to return. If this number is less than the total
number of tags associated with the stream, HasMoreTags
is set to
true
. To list additional tags, set ExclusiveStartTagKey
to the last
key in the response.
listTagsForStream_streamARN :: Lens' ListTagsForStream (Maybe Text) Source #
The ARN of the stream.
listTagsForStream_streamName :: Lens' ListTagsForStream (Maybe Text) Source #
The name of the stream.
listTagsForStreamResponse_httpStatus :: Lens' ListTagsForStreamResponse Int Source #
The response's http status code.
listTagsForStreamResponse_tags :: Lens' ListTagsForStreamResponse [Tag] Source #
A list of tags associated with StreamName
, starting with the first tag
after ExclusiveStartTagKey
and up to the specified Limit
.
listTagsForStreamResponse_hasMoreTags :: Lens' ListTagsForStreamResponse Bool Source #
If set to true
, more tags are available. To request additional tags,
set ExclusiveStartTagKey
to the key of the last tag returned.
MergeShards
mergeShards_streamARN :: Lens' MergeShards (Maybe Text) Source #
The ARN of the stream.
mergeShards_streamName :: Lens' MergeShards (Maybe Text) Source #
The name of the stream for the merge.
mergeShards_shardToMerge :: Lens' MergeShards Text Source #
The shard ID of the shard to combine with the adjacent shard for the merge.
mergeShards_adjacentShardToMerge :: Lens' MergeShards Text Source #
The shard ID of the adjacent shard for the merge.
PutRecord
putRecord_explicitHashKey :: Lens' PutRecord (Maybe Text) Source #
The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
putRecord_sequenceNumberForOrdering :: Lens' PutRecord (Maybe Text) Source #
Guarantees strictly increasing sequence numbers, for puts from the same
client and to the same partition key. Usage: set the
SequenceNumberForOrdering
of record n to the sequence number of
record n-1 (as returned in the result when putting record n-1). If
this parameter is not set, records are coarsely ordered based on arrival
time.
putRecord_streamName :: Lens' PutRecord (Maybe Text) Source #
The name of the stream to put the data record into.
putRecord_data :: Lens' PutRecord ByteString Source #
The data blob to put into the record, which is base64-encoded when the
blob is serialized. When the data blob (the payload before
base64-encoding) is added to the partition key size, the total size must
not exceed the maximum record size (1 MiB).--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
putRecord_partitionKey :: Lens' PutRecord Text Source #
Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
putRecordResponse_encryptionType :: Lens' PutRecordResponse (Maybe EncryptionType) Source #
The encryption type to use on the record. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
putRecordResponse_httpStatus :: Lens' PutRecordResponse Int Source #
The response's http status code.
putRecordResponse_shardId :: Lens' PutRecordResponse Text Source #
The shard ID of the shard where the data record was placed.
putRecordResponse_sequenceNumber :: Lens' PutRecordResponse Text Source #
The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.
PutRecords
putRecords_streamARN :: Lens' PutRecords (Maybe Text) Source #
The ARN of the stream.
putRecords_streamName :: Lens' PutRecords (Maybe Text) Source #
The stream name associated with the request.
putRecords_records :: Lens' PutRecords (NonEmpty PutRecordsRequestEntry) Source #
The records associated with the request.
putRecordsResponse_encryptionType :: Lens' PutRecordsResponse (Maybe EncryptionType) Source #
The encryption type used on the records. This parameter can be one of the following values:
NONE
: Do not encrypt the records.KMS
: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
putRecordsResponse_failedRecordCount :: Lens' PutRecordsResponse (Maybe Natural) Source #
The number of unsuccessfully processed records in a PutRecords
request.
putRecordsResponse_httpStatus :: Lens' PutRecordsResponse Int Source #
The response's http status code.
putRecordsResponse_records :: Lens' PutRecordsResponse (NonEmpty PutRecordsResultEntry) Source #
An array of successfully and unsuccessfully processed record results. A
record that is successfully added to a stream includes SequenceNumber
and ShardId
in the result. A record that fails to be added to a stream
includes ErrorCode
and ErrorMessage
in the result.
RegisterStreamConsumer
registerStreamConsumer_streamARN :: Lens' RegisterStreamConsumer Text Source #
The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
registerStreamConsumer_consumerName :: Lens' RegisterStreamConsumer Text Source #
For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
registerStreamConsumerResponse_httpStatus :: Lens' RegisterStreamConsumerResponse Int Source #
The response's http status code.
registerStreamConsumerResponse_consumer :: Lens' RegisterStreamConsumerResponse Consumer Source #
An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.
RemoveTagsFromStream
removeTagsFromStream_streamARN :: Lens' RemoveTagsFromStream (Maybe Text) Source #
The ARN of the stream.
removeTagsFromStream_streamName :: Lens' RemoveTagsFromStream (Maybe Text) Source #
The name of the stream.
removeTagsFromStream_tagKeys :: Lens' RemoveTagsFromStream (NonEmpty Text) Source #
A list of tag keys. Each corresponding tag is removed from the stream.
SplitShard
splitShard_streamARN :: Lens' SplitShard (Maybe Text) Source #
The ARN of the stream.
splitShard_streamName :: Lens' SplitShard (Maybe Text) Source #
The name of the stream for the shard split.
splitShard_shardToSplit :: Lens' SplitShard Text Source #
The shard ID of the shard to split.
splitShard_newStartingHashKey :: Lens' SplitShard Text Source #
A hash key value for the starting hash key of one of the child shards
created by the split. The hash key range for a given shard constitutes a
set of ordered contiguous positive integers. The value for
NewStartingHashKey
must be in the range of hash keys being mapped into
the shard. The NewStartingHashKey
hash key value and all higher hash
key values in hash key range are distributed to one of the child shards.
All the lower hash key values in the range are distributed to the other
child shard.
StartStreamEncryption
startStreamEncryption_streamARN :: Lens' StartStreamEncryption (Maybe Text) Source #
The ARN of the stream.
startStreamEncryption_streamName :: Lens' StartStreamEncryption (Maybe Text) Source #
The name of the stream for which to start encrypting records.
startStreamEncryption_encryptionType :: Lens' StartStreamEncryption EncryptionType Source #
The encryption type to use. The only valid value is KMS
.
startStreamEncryption_keyId :: Lens' StartStreamEncryption Text Source #
The GUID for the customer-managed Amazon Web Services KMS key to use for
encryption. This value can be a globally unique identifier, a fully
specified Amazon Resource Name (ARN) to either an alias or a key, or an
alias name prefixed by "alias/".You can also use a master key owned
by Kinesis Data Streams by specifying the alias aws/kinesis
.
- Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
- Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
- Globally unique key ID example:
12345678-1234-1234-1234-123456789012
- Alias name example:
alias/MyAliasName
- Master key owned by Kinesis Data Streams:
alias/aws/kinesis
StopStreamEncryption
stopStreamEncryption_streamARN :: Lens' StopStreamEncryption (Maybe Text) Source #
The ARN of the stream.
stopStreamEncryption_streamName :: Lens' StopStreamEncryption (Maybe Text) Source #
The name of the stream on which to stop encrypting records.
stopStreamEncryption_encryptionType :: Lens' StopStreamEncryption EncryptionType Source #
The encryption type. The only valid value is KMS
.
stopStreamEncryption_keyId :: Lens' StopStreamEncryption Text Source #
The GUID for the customer-managed Amazon Web Services KMS key to use for
encryption. This value can be a globally unique identifier, a fully
specified Amazon Resource Name (ARN) to either an alias or a key, or an
alias name prefixed by "alias/".You can also use a master key owned
by Kinesis Data Streams by specifying the alias aws/kinesis
.
- Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
- Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
- Globally unique key ID example:
12345678-1234-1234-1234-123456789012
- Alias name example:
alias/MyAliasName
- Master key owned by Kinesis Data Streams:
alias/aws/kinesis
SubscribeToShard
subscribeToShard_consumerARN :: Lens' SubscribeToShard Text Source #
For this parameter, use the value you obtained when you called RegisterStreamConsumer.
subscribeToShard_shardId :: Lens' SubscribeToShard Text Source #
The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.
subscribeToShard_startingPosition :: Lens' SubscribeToShard StartingPosition Source #
The starting position in the data stream from which to start streaming.
subscribeToShardResponse_httpStatus :: Lens' SubscribeToShardResponse Int Source #
The response's http status code.
subscribeToShardResponse_eventStream :: Lens' SubscribeToShardResponse Value Source #
The event stream that your consumer can use to read records from the shard.
UpdateShardCount
updateShardCount_streamARN :: Lens' UpdateShardCount (Maybe Text) Source #
The ARN of the stream.
updateShardCount_streamName :: Lens' UpdateShardCount (Maybe Text) Source #
The name of the stream.
updateShardCount_targetShardCount :: Lens' UpdateShardCount Natural Source #
The new number of shards. This value has the following default limits. By default, you cannot do the following:
- Set this value to more than double your current shard count for a stream.
- Set this value below half your current shard count for a stream.
- Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.
- Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.
updateShardCount_scalingType :: Lens' UpdateShardCount ScalingType Source #
The scaling type. Uniform scaling creates shards of equal size.
updateShardCountResponse_currentShardCount :: Lens' UpdateShardCountResponse (Maybe Natural) Source #
The current number of shards.
updateShardCountResponse_streamARN :: Lens' UpdateShardCountResponse (Maybe Text) Source #
The ARN of the stream.
updateShardCountResponse_streamName :: Lens' UpdateShardCountResponse (Maybe Text) Source #
The name of the stream.
updateShardCountResponse_targetShardCount :: Lens' UpdateShardCountResponse (Maybe Natural) Source #
The updated number of shards.
updateShardCountResponse_httpStatus :: Lens' UpdateShardCountResponse Int Source #
The response's http status code.
UpdateStreamMode
updateStreamMode_streamARN :: Lens' UpdateStreamMode Text Source #
Specifies the ARN of the data stream whose capacity mode you want to update.
updateStreamMode_streamModeDetails :: Lens' UpdateStreamMode StreamModeDetails Source #
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
Types
ChildShard
childShard_shardId :: Lens' ChildShard Text Source #
The shard ID of the existing child shard of the current shard.
childShard_parentShards :: Lens' ChildShard [Text] Source #
The current shard that is the parent of the existing child shard.
childShard_hashKeyRange :: Lens' ChildShard HashKeyRange Source #
Undocumented member.
Consumer
consumer_consumerName :: Lens' Consumer Text Source #
The name of the consumer is something you choose when you register the consumer.
consumer_consumerARN :: Lens' Consumer Text Source #
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
consumer_consumerStatus :: Lens' Consumer ConsumerStatus Source #
A consumer can't read data while in the CREATING
or DELETING
states.
ConsumerDescription
consumerDescription_consumerName :: Lens' ConsumerDescription Text Source #
The name of the consumer is something you choose when you register the consumer.
consumerDescription_consumerARN :: Lens' ConsumerDescription Text Source #
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
consumerDescription_consumerStatus :: Lens' ConsumerDescription ConsumerStatus Source #
A consumer can't read data while in the CREATING
or DELETING
states.
consumerDescription_streamARN :: Lens' ConsumerDescription Text Source #
The ARN of the stream with which you registered the consumer.
EnhancedMetrics
enhancedMetrics_shardLevelMetrics :: Lens' EnhancedMetrics (Maybe [MetricsName]) Source #
List of shard-level metrics.
The following are the valid shard-level metrics. The value "ALL
"
enhances every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
EnhancedMonitoringOutput
enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #
Represents the current state of the metrics that are in the enhanced state before the operation.
enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName]) Source #
Represents the list of all the metrics that would be in the enhanced state after the operation.
enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #
The ARN of the stream.
enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #
The name of the Kinesis data stream.
HashKeyRange
hashKeyRange_startingHashKey :: Lens' HashKeyRange Text Source #
The starting hash key of the hash key range.
hashKeyRange_endingHashKey :: Lens' HashKeyRange Text Source #
The ending hash key of the hash key range.
PutRecordsRequestEntry
putRecordsRequestEntry_explicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text) Source #
The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
putRecordsRequestEntry_data :: Lens' PutRecordsRequestEntry ByteString Source #
The data blob to put into the record, which is base64-encoded when the
blob is serialized. When the data blob (the payload before
base64-encoding) is added to the partition key size, the total size must
not exceed the maximum record size (1 MiB).--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
putRecordsRequestEntry_partitionKey :: Lens' PutRecordsRequestEntry Text Source #
Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
PutRecordsResultEntry
putRecordsResultEntry_errorCode :: Lens' PutRecordsResultEntry (Maybe Text) Source #
The error code for an individual record result. ErrorCodes
can be
either ProvisionedThroughputExceededException
or InternalFailure
.
putRecordsResultEntry_errorMessage :: Lens' PutRecordsResultEntry (Maybe Text) Source #
The error message for an individual record result. An ErrorCode
value
of ProvisionedThroughputExceededException
has an error message that
includes the account ID, stream name, and shard ID. An ErrorCode
value
of InternalFailure
has the error message
"Internal Service Failure"
.
putRecordsResultEntry_sequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text) Source #
The sequence number for an individual record result.
putRecordsResultEntry_shardId :: Lens' PutRecordsResultEntry (Maybe Text) Source #
The shard ID for an individual record result.
Record
record_approximateArrivalTimestamp :: Lens' Record (Maybe UTCTime) Source #
The approximate time that the record was inserted into the stream.
record_encryptionType :: Lens' Record (Maybe EncryptionType) Source #
The encryption type used on the record. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
record_sequenceNumber :: Lens' Record Text Source #
The unique identifier of the record within its shard.
record_data :: Lens' Record ByteString Source #
The data blob. The data in the blob is both opaque and immutable to
Kinesis Data Streams, which does not inspect, interpret, or change the
data in the blob in any way. When the data blob (the payload before
base64-encoding) is added to the partition key size, the total size must
not exceed the maximum record size (1 MiB).--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
record_partitionKey :: Lens' Record Text Source #
Identifies which shard in the stream the data record is assigned to.
SequenceNumberRange
sequenceNumberRange_endingSequenceNumber :: 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
.
sequenceNumberRange_startingSequenceNumber :: Lens' SequenceNumberRange Text Source #
The starting sequence number for the range.
Shard
shard_adjacentParentShardId :: Lens' Shard (Maybe Text) Source #
The shard ID of the shard adjacent to the shard's parent.
shard_hashKeyRange :: Lens' Shard HashKeyRange Source #
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
shard_sequenceNumberRange :: Lens' Shard SequenceNumberRange Source #
The range of possible sequence numbers for the shard.
ShardFilter
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 theShardId
that you provided.AT_TRIM_HORIZON
- the response includes all the shards that were open atTRIM_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 toTRIM_HORIZON
of the data stream ifFROM_TIMESTAMP
is less than theTRIM_HORIZON
value.
StartingPosition
startingPosition_sequenceNumber :: Lens' StartingPosition (Maybe Text) Source #
The sequence number of the data record in the shard from which to start
streaming. To specify a sequence number, set StartingPosition
to
AT_SEQUENCE_NUMBER
or AFTER_SEQUENCE_NUMBER
.
startingPosition_timestamp :: Lens' StartingPosition (Maybe UTCTime) Source #
The time stamp of the data record from which to start reading. To
specify a time stamp, set StartingPosition
to Type AT_TIMESTAMP
. A
time stamp is the Unix epoch date with precision in milliseconds. For
example, 2016-04-04T19:58:46.480-00:00
or 1459799926.480
. If a
record with this exact time stamp does not exist, records will be
streamed from the next (later) record. If the time stamp is older than
the current trim horizon, records will be streamed from the oldest
untrimmed data record (TRIM_HORIZON
).
startingPosition_type :: Lens' StartingPosition ShardIteratorType Source #
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER
: Start streaming from the position denoted by the
sequence number specified in the SequenceNumber
field.
AFTER_SEQUENCE_NUMBER
: Start streaming right after the position
denoted by the sequence number specified in the SequenceNumber
field.
AT_TIMESTAMP
: Start streaming from the position denoted by the time
stamp specified in the Timestamp
field.
TRIM_HORIZON
: Start streaming at the last untrimmed record in the
shard, which is the oldest data record in the shard.
LATEST
: Start streaming just after the most recent record in the
shard, so that you always read the most recent data in the shard.
StreamDescription
streamDescription_encryptionType :: Lens' StreamDescription (Maybe EncryptionType) Source #
The server-side encryption type used on the stream. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
streamDescription_keyId :: Lens' StreamDescription (Maybe Text) Source #
The GUID for the customer-managed Amazon Web Services KMS key to use for
encryption. This value can be a globally unique identifier, a fully
specified ARN to either an alias or a key, or an alias name prefixed by
"alias/".You can also use a master key owned by Kinesis Data Streams
by specifying the alias aws/kinesis
.
- Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
- Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
- Globally unique key ID example:
12345678-1234-1234-1234-123456789012
- Alias name example:
alias/MyAliasName
- Master key owned by Kinesis Data Streams:
alias/aws/kinesis
streamDescription_streamModeDetails :: Lens' StreamDescription (Maybe StreamModeDetails) Source #
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
streamDescription_streamName :: Lens' StreamDescription Text Source #
The name of the stream being described.
streamDescription_streamARN :: Lens' StreamDescription Text Source #
The Amazon Resource Name (ARN) for the stream being described.
streamDescription_streamStatus :: 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. Kinesis Data Streams immediately returns and setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
state until Kinesis Data Streams 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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
streamDescription_shards :: Lens' StreamDescription [Shard] Source #
The shards that comprise the stream.
streamDescription_hasMoreShards :: Lens' StreamDescription Bool Source #
If set to true
, more shards in the stream are available to describe.
streamDescription_retentionPeriodHours :: Lens' StreamDescription Int Source #
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
streamDescription_streamCreationTimestamp :: Lens' StreamDescription UTCTime Source #
The approximate time that the stream was created.
streamDescription_enhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics] Source #
Represents the current enhanced monitoring settings of the stream.
StreamDescriptionSummary
streamDescriptionSummary_consumerCount :: Lens' StreamDescriptionSummary (Maybe Natural) Source #
The number of enhanced fan-out consumers registered with the stream.
streamDescriptionSummary_encryptionType :: Lens' StreamDescriptionSummary (Maybe EncryptionType) Source #
The encryption type used. This value is one of the following:
KMS
NONE
streamDescriptionSummary_keyId :: Lens' StreamDescriptionSummary (Maybe Text) Source #
The GUID for the customer-managed Amazon Web Services KMS key to use for
encryption. This value can be a globally unique identifier, a fully
specified ARN to either an alias or a key, or an alias name prefixed by
"alias/".You can also use a master key owned by Kinesis Data Streams
by specifying the alias aws/kinesis
.
- Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
- Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
- Globally unique key ID example:
12345678-1234-1234-1234-123456789012
- Alias name example:
alias/MyAliasName
- Master key owned by Kinesis Data Streams:
alias/aws/kinesis
streamDescriptionSummary_streamModeDetails :: Lens' StreamDescriptionSummary (Maybe StreamModeDetails) Source #
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
streamDescriptionSummary_streamName :: Lens' StreamDescriptionSummary Text Source #
The name of the stream being described.
streamDescriptionSummary_streamARN :: Lens' StreamDescriptionSummary Text Source #
The Amazon Resource Name (ARN) for the stream being described.
streamDescriptionSummary_streamStatus :: Lens' StreamDescriptionSummary 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. Kinesis Data Streams immediately returns and setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
state until Kinesis Data Streams 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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
streamDescriptionSummary_retentionPeriodHours :: Lens' StreamDescriptionSummary Int Source #
The current retention period, in hours.
streamDescriptionSummary_streamCreationTimestamp :: Lens' StreamDescriptionSummary UTCTime Source #
The approximate time that the stream was created.
streamDescriptionSummary_enhancedMonitoring :: Lens' StreamDescriptionSummary [EnhancedMetrics] Source #
Represents the current enhanced monitoring settings of the stream.
streamDescriptionSummary_openShardCount :: Lens' StreamDescriptionSummary Natural Source #
The number of open shards in the stream.
StreamModeDetails
streamModeDetails_streamMode :: Lens' StreamModeDetails StreamMode Source #
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
StreamSummary
streamSummary_streamCreationTimestamp :: Lens' StreamSummary (Maybe UTCTime) Source #
The timestamp at which the stream was created.
streamSummary_streamModeDetails :: Lens' StreamSummary (Maybe StreamModeDetails) Source #
Undocumented member.
streamSummary_streamName :: Lens' StreamSummary Text Source #
The name of a stream.
streamSummary_streamARN :: Lens' StreamSummary Text Source #
The ARN of the stream.
streamSummary_streamStatus :: Lens' StreamSummary StreamStatus Source #
The status of the stream.
SubscribeToShardEvent
subscribeToShardEvent_childShards :: Lens' SubscribeToShardEvent (Maybe [ChildShard]) Source #
The list of the child shards of the current shard, returned only at the end of the current shard.
subscribeToShardEvent_continuationSequenceNumber :: Lens' SubscribeToShardEvent Text Source #
Use this as SequenceNumber
in the next call to SubscribeToShard, with
StartingPosition
set to AT_SEQUENCE_NUMBER
or
AFTER_SEQUENCE_NUMBER
. Use ContinuationSequenceNumber
for
checkpointing because it captures your shard progress even when no data
is written to the shard.
subscribeToShardEvent_millisBehindLatest :: Lens' SubscribeToShardEvent Natural Source #
The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.