| 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
Contents
- Service Configuration
- Errors
- ConsumerStatus
- EncryptionType
- MetricsName
- ScalingType
- ShardFilterType
- ShardIteratorType
- StreamMode
- StreamStatus
- ChildShard
- Consumer
- ConsumerDescription
- EnhancedMetrics
- EnhancedMonitoringOutput
- HashKeyRange
- PutRecordsRequestEntry
- PutRecordsResultEntry
- Record
- SequenceNumberRange
- Shard
- ShardFilter
- StartingPosition
- StreamDescription
- StreamDescriptionSummary
- StreamModeDetails
- StreamSummary
- SubscribeToShardEvent
- Tag
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ExpiredIteratorException :: AsError a => Fold a ServiceError
- _ExpiredNextTokenException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _KMSAccessDeniedException :: AsError a => Fold a ServiceError
- _KMSDisabledException :: AsError a => Fold a ServiceError
- _KMSInvalidStateException :: AsError a => Fold a ServiceError
- _KMSNotFoundException :: AsError a => Fold a ServiceError
- _KMSOptInRequired :: AsError a => Fold a ServiceError
- _KMSThrottlingException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype ConsumerStatus where
- ConsumerStatus' { }
- pattern ConsumerStatus_ACTIVE :: ConsumerStatus
- pattern ConsumerStatus_CREATING :: ConsumerStatus
- pattern ConsumerStatus_DELETING :: ConsumerStatus
- newtype EncryptionType where
- EncryptionType' { }
- pattern EncryptionType_KMS :: EncryptionType
- pattern EncryptionType_NONE :: EncryptionType
- newtype MetricsName where
- MetricsName' { }
- pattern MetricsName_ALL :: MetricsName
- pattern MetricsName_IncomingBytes :: MetricsName
- pattern MetricsName_IncomingRecords :: MetricsName
- pattern MetricsName_IteratorAgeMilliseconds :: MetricsName
- pattern MetricsName_OutgoingBytes :: MetricsName
- pattern MetricsName_OutgoingRecords :: MetricsName
- pattern MetricsName_ReadProvisionedThroughputExceeded :: MetricsName
- pattern MetricsName_WriteProvisionedThroughputExceeded :: MetricsName
- newtype ScalingType where
- ScalingType' { }
- pattern ScalingType_UNIFORM_SCALING :: ScalingType
- newtype ShardFilterType where
- ShardFilterType' { }
- pattern ShardFilterType_AFTER_SHARD_ID :: ShardFilterType
- pattern ShardFilterType_AT_LATEST :: ShardFilterType
- pattern ShardFilterType_AT_TIMESTAMP :: ShardFilterType
- pattern ShardFilterType_AT_TRIM_HORIZON :: ShardFilterType
- pattern ShardFilterType_FROM_TIMESTAMP :: ShardFilterType
- pattern ShardFilterType_FROM_TRIM_HORIZON :: ShardFilterType
- newtype ShardIteratorType where
- ShardIteratorType' { }
- pattern ShardIteratorType_AFTER_SEQUENCE_NUMBER :: ShardIteratorType
- pattern ShardIteratorType_AT_SEQUENCE_NUMBER :: ShardIteratorType
- pattern ShardIteratorType_AT_TIMESTAMP :: ShardIteratorType
- pattern ShardIteratorType_LATEST :: ShardIteratorType
- pattern ShardIteratorType_TRIM_HORIZON :: ShardIteratorType
- newtype StreamMode where
- StreamMode' { }
- pattern StreamMode_ON_DEMAND :: StreamMode
- pattern StreamMode_PROVISIONED :: StreamMode
- newtype StreamStatus where
- StreamStatus' { }
- pattern StreamStatus_ACTIVE :: StreamStatus
- pattern StreamStatus_CREATING :: StreamStatus
- pattern StreamStatus_DELETING :: StreamStatus
- pattern StreamStatus_UPDATING :: StreamStatus
- data ChildShard = ChildShard' {
- shardId :: Text
- parentShards :: [Text]
- hashKeyRange :: HashKeyRange
- newChildShard :: Text -> HashKeyRange -> ChildShard
- childShard_shardId :: Lens' ChildShard Text
- childShard_parentShards :: Lens' ChildShard [Text]
- childShard_hashKeyRange :: Lens' ChildShard HashKeyRange
- data Consumer = Consumer' {}
- newConsumer :: Text -> Text -> ConsumerStatus -> UTCTime -> Consumer
- consumer_consumerName :: Lens' Consumer Text
- consumer_consumerARN :: Lens' Consumer Text
- consumer_consumerStatus :: Lens' Consumer ConsumerStatus
- consumer_consumerCreationTimestamp :: Lens' Consumer UTCTime
- data ConsumerDescription = ConsumerDescription' {}
- newConsumerDescription :: Text -> Text -> ConsumerStatus -> UTCTime -> Text -> ConsumerDescription
- 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
- data EnhancedMetrics = EnhancedMetrics' {}
- newEnhancedMetrics :: EnhancedMetrics
- enhancedMetrics_shardLevelMetrics :: Lens' EnhancedMetrics (Maybe [MetricsName])
- data EnhancedMonitoringOutput = EnhancedMonitoringOutput' {}
- newEnhancedMonitoringOutput :: EnhancedMonitoringOutput
- enhancedMonitoringOutput_currentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_desiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe [MetricsName])
- enhancedMonitoringOutput_streamARN :: Lens' EnhancedMonitoringOutput (Maybe Text)
- enhancedMonitoringOutput_streamName :: Lens' EnhancedMonitoringOutput (Maybe Text)
- data HashKeyRange = HashKeyRange' {}
- newHashKeyRange :: Text -> Text -> HashKeyRange
- hashKeyRange_startingHashKey :: Lens' HashKeyRange Text
- hashKeyRange_endingHashKey :: Lens' HashKeyRange Text
- data PutRecordsRequestEntry = PutRecordsRequestEntry' {
- explicitHashKey :: Maybe Text
- data' :: Base64
- partitionKey :: Text
- newPutRecordsRequestEntry :: ByteString -> Text -> PutRecordsRequestEntry
- putRecordsRequestEntry_explicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)
- putRecordsRequestEntry_data :: Lens' PutRecordsRequestEntry ByteString
- putRecordsRequestEntry_partitionKey :: Lens' PutRecordsRequestEntry Text
- data PutRecordsResultEntry = PutRecordsResultEntry' {}
- newPutRecordsResultEntry :: PutRecordsResultEntry
- putRecordsResultEntry_errorCode :: Lens' PutRecordsResultEntry (Maybe Text)
- putRecordsResultEntry_errorMessage :: Lens' PutRecordsResultEntry (Maybe Text)
- putRecordsResultEntry_sequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text)
- putRecordsResultEntry_shardId :: Lens' PutRecordsResultEntry (Maybe Text)
- data Record = Record' {}
- newRecord :: Text -> ByteString -> Text -> Record
- 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
- data SequenceNumberRange = SequenceNumberRange' {}
- newSequenceNumberRange :: Text -> SequenceNumberRange
- sequenceNumberRange_endingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)
- sequenceNumberRange_startingSequenceNumber :: Lens' SequenceNumberRange Text
- data Shard = Shard' {}
- newShard :: Text -> HashKeyRange -> SequenceNumberRange -> Shard
- 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
- data ShardFilter = ShardFilter' {}
- newShardFilter :: ShardFilterType -> ShardFilter
- shardFilter_shardId :: Lens' ShardFilter (Maybe Text)
- shardFilter_timestamp :: Lens' ShardFilter (Maybe UTCTime)
- shardFilter_type :: Lens' ShardFilter ShardFilterType
- data StartingPosition = StartingPosition' {}
- newStartingPosition :: ShardIteratorType -> StartingPosition
- startingPosition_sequenceNumber :: Lens' StartingPosition (Maybe Text)
- startingPosition_timestamp :: Lens' StartingPosition (Maybe UTCTime)
- startingPosition_type :: Lens' StartingPosition ShardIteratorType
- data StreamDescription = StreamDescription' {
- encryptionType :: Maybe EncryptionType
- keyId :: Maybe Text
- streamModeDetails :: Maybe StreamModeDetails
- streamName :: Text
- streamARN :: Text
- streamStatus :: StreamStatus
- shards :: [Shard]
- hasMoreShards :: Bool
- retentionPeriodHours :: Int
- streamCreationTimestamp :: POSIX
- enhancedMonitoring :: [EnhancedMetrics]
- newStreamDescription :: Text -> Text -> StreamStatus -> Bool -> Int -> UTCTime -> StreamDescription
- 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]
- data StreamDescriptionSummary = StreamDescriptionSummary' {
- consumerCount :: Maybe Natural
- encryptionType :: Maybe EncryptionType
- keyId :: Maybe Text
- streamModeDetails :: Maybe StreamModeDetails
- streamName :: Text
- streamARN :: Text
- streamStatus :: StreamStatus
- retentionPeriodHours :: Int
- streamCreationTimestamp :: POSIX
- enhancedMonitoring :: [EnhancedMetrics]
- openShardCount :: Natural
- newStreamDescriptionSummary :: Text -> Text -> StreamStatus -> Int -> UTCTime -> Natural -> StreamDescriptionSummary
- 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
- data StreamModeDetails = StreamModeDetails' {}
- newStreamModeDetails :: StreamMode -> StreamModeDetails
- streamModeDetails_streamMode :: Lens' StreamModeDetails StreamMode
- data StreamSummary = StreamSummary' {}
- newStreamSummary :: Text -> Text -> StreamStatus -> StreamSummary
- 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
- data SubscribeToShardEvent = SubscribeToShardEvent' {}
- newSubscribeToShardEvent :: Text -> Natural -> SubscribeToShardEvent
- subscribeToShardEvent_childShards :: Lens' SubscribeToShardEvent (Maybe [ChildShard])
- subscribeToShardEvent_records :: Lens' SubscribeToShardEvent [Record]
- subscribeToShardEvent_continuationSequenceNumber :: Lens' SubscribeToShardEvent Text
- subscribeToShardEvent_millisBehindLatest :: Lens' SubscribeToShardEvent Natural
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2013-12-02 of the Amazon Kinesis SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Specifies that you do not have the permissions required to perform this operation.
_ExpiredIteratorException :: AsError a => Fold a ServiceError Source #
The provided iterator exceeds the maximum age allowed.
_ExpiredNextTokenException :: AsError a => Fold a ServiceError Source #
The pagination token passed to the operation is expired.
_InternalFailureException :: AsError a => Fold a ServiceError Source #
The processing of the request failed because of an unknown error, exception, or failure.
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
_KMSAccessDeniedException :: AsError a => Fold a ServiceError Source #
The ciphertext references a key that doesn't exist or that you don't have access to.
_KMSDisabledException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified customer master key (CMK) isn't enabled.
_KMSInvalidStateException :: AsError a => Fold a ServiceError Source #
The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.
_KMSNotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified entity or resource can't be found.
_KMSOptInRequired :: AsError a => Fold a ServiceError Source #
The Amazon Web Services access key ID needs a subscription for the service.
_KMSThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
_ProvisionedThroughputExceededException :: AsError a => Fold a ServiceError Source #
The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The resource is not available for this operation. For successful
operation, the resource must be in the ACTIVE state.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource could not be found. The stream might not be specified correctly.
_ValidationException :: AsError a => Fold a ServiceError Source #
Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.
ConsumerStatus
newtype ConsumerStatus Source #
Constructors
| ConsumerStatus' | |
Fields | |
Bundled Patterns
| pattern ConsumerStatus_ACTIVE :: ConsumerStatus | |
| pattern ConsumerStatus_CREATING :: ConsumerStatus | |
| pattern ConsumerStatus_DELETING :: ConsumerStatus |
Instances
EncryptionType
newtype EncryptionType Source #
Constructors
| EncryptionType' | |
Fields | |
Bundled Patterns
| pattern EncryptionType_KMS :: EncryptionType | |
| pattern EncryptionType_NONE :: EncryptionType |
Instances
MetricsName
newtype MetricsName Source #
Constructors
| MetricsName' | |
Fields | |
Bundled Patterns
| pattern MetricsName_ALL :: MetricsName | |
| pattern MetricsName_IncomingBytes :: MetricsName | |
| pattern MetricsName_IncomingRecords :: MetricsName | |
| pattern MetricsName_IteratorAgeMilliseconds :: MetricsName | |
| pattern MetricsName_OutgoingBytes :: MetricsName | |
| pattern MetricsName_OutgoingRecords :: MetricsName | |
| pattern MetricsName_ReadProvisionedThroughputExceeded :: MetricsName | |
| pattern MetricsName_WriteProvisionedThroughputExceeded :: MetricsName |
Instances
ScalingType
newtype ScalingType Source #
Constructors
| ScalingType' | |
Fields | |
Bundled Patterns
| pattern ScalingType_UNIFORM_SCALING :: ScalingType |
Instances
ShardFilterType
newtype ShardFilterType Source #
Constructors
| ShardFilterType' | |
Fields | |
Bundled Patterns
| pattern ShardFilterType_AFTER_SHARD_ID :: ShardFilterType | |
| pattern ShardFilterType_AT_LATEST :: ShardFilterType | |
| pattern ShardFilterType_AT_TIMESTAMP :: ShardFilterType | |
| pattern ShardFilterType_AT_TRIM_HORIZON :: ShardFilterType | |
| pattern ShardFilterType_FROM_TIMESTAMP :: ShardFilterType | |
| pattern ShardFilterType_FROM_TRIM_HORIZON :: ShardFilterType |
Instances
ShardIteratorType
newtype ShardIteratorType Source #
Constructors
| ShardIteratorType' | |
Fields | |
Bundled Patterns
| pattern ShardIteratorType_AFTER_SEQUENCE_NUMBER :: ShardIteratorType | |
| pattern ShardIteratorType_AT_SEQUENCE_NUMBER :: ShardIteratorType | |
| pattern ShardIteratorType_AT_TIMESTAMP :: ShardIteratorType | |
| pattern ShardIteratorType_LATEST :: ShardIteratorType | |
| pattern ShardIteratorType_TRIM_HORIZON :: ShardIteratorType |
Instances
StreamMode
newtype StreamMode Source #
Constructors
| StreamMode' | |
Fields | |
Bundled Patterns
| pattern StreamMode_ON_DEMAND :: StreamMode | |
| pattern StreamMode_PROVISIONED :: StreamMode |
Instances
StreamStatus
newtype StreamStatus Source #
Constructors
| StreamStatus' | |
Fields | |
Bundled Patterns
| pattern StreamStatus_ACTIVE :: StreamStatus | |
| pattern StreamStatus_CREATING :: StreamStatus | |
| pattern StreamStatus_DELETING :: StreamStatus | |
| pattern StreamStatus_UPDATING :: StreamStatus |
Instances
ChildShard
data ChildShard Source #
Output parameter of the GetRecords API. The existing child shard of the current shard.
See: newChildShard smart constructor.
Constructors
| ChildShard' | |
Fields
| |
Instances
Create a value of ChildShard 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:ChildShard', childShard_shardId - The shard ID of the existing child shard of the current shard.
$sel:parentShards:ChildShard', childShard_parentShards - The current shard that is the parent of the existing child shard.
$sel:hashKeyRange:ChildShard', childShard_hashKeyRange - Undocumented member.
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
An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.
See: newConsumer smart constructor.
Constructors
| Consumer' | |
Fields
| |
Instances
| FromJSON Consumer Source # | |
| Generic Consumer Source # | |
| Read Consumer Source # | |
| Show Consumer Source # | |
| NFData Consumer Source # | |
Defined in Amazonka.Kinesis.Types.Consumer | |
| Eq Consumer Source # | |
| Hashable Consumer Source # | |
Defined in Amazonka.Kinesis.Types.Consumer | |
| type Rep Consumer Source # | |
Defined in Amazonka.Kinesis.Types.Consumer type Rep Consumer = D1 ('MetaData "Consumer" "Amazonka.Kinesis.Types.Consumer" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "Consumer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "consumerStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConsumerStatus) :*: S1 ('MetaSel ('Just "consumerCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))) | |
Arguments
| :: Text | |
| -> Text | |
| -> ConsumerStatus | |
| -> UTCTime | |
| -> Consumer |
Create a value of Consumer 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:consumerName:Consumer', consumer_consumerName - The name of the consumer is something you choose when you register the
consumer.
$sel:consumerARN:Consumer', consumer_consumerARN - 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.
$sel:consumerStatus:Consumer', consumer_consumerStatus - A consumer can't read data while in the CREATING or DELETING
states.
$sel:consumerCreationTimestamp:Consumer', consumer_consumerCreationTimestamp -
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
data ConsumerDescription Source #
An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.
See: newConsumerDescription smart constructor.
Constructors
| ConsumerDescription' | |
Fields
| |
Instances
newConsumerDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> ConsumerStatus | |
| -> UTCTime | |
| -> Text | |
| -> ConsumerDescription |
Create a value of ConsumerDescription 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:consumerName:ConsumerDescription', consumerDescription_consumerName - The name of the consumer is something you choose when you register the
consumer.
$sel:consumerARN:ConsumerDescription', consumerDescription_consumerARN - 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.
$sel:consumerStatus:ConsumerDescription', consumerDescription_consumerStatus - A consumer can't read data while in the CREATING or DELETING
states.
$sel:consumerCreationTimestamp:ConsumerDescription', consumerDescription_consumerCreationTimestamp -
$sel:streamARN:ConsumerDescription', consumerDescription_streamARN - The ARN of the stream with which you registered the consumer.
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
data EnhancedMetrics Source #
Represents enhanced metrics types.
See: newEnhancedMetrics smart constructor.
Constructors
| EnhancedMetrics' | |
Fields
| |
Instances
newEnhancedMetrics :: EnhancedMetrics Source #
Create a value of EnhancedMetrics 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:shardLevelMetrics:EnhancedMetrics', enhancedMetrics_shardLevelMetrics - 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.
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
data EnhancedMonitoringOutput Source #
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
See: newEnhancedMonitoringOutput smart constructor.
Constructors
| EnhancedMonitoringOutput' | |
Fields
| |
Instances
newEnhancedMonitoringOutput :: EnhancedMonitoringOutput Source #
Create a value of EnhancedMonitoringOutput 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:currentShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_currentShardLevelMetrics - Represents the current state of the metrics that are in the enhanced
state before the operation.
$sel:desiredShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_desiredShardLevelMetrics - Represents the list of all the metrics that would be in the enhanced
state after the operation.
$sel:streamARN:EnhancedMonitoringOutput', enhancedMonitoringOutput_streamARN - The ARN of the stream.
$sel:streamName:EnhancedMonitoringOutput', enhancedMonitoringOutput_streamName - The name of the Kinesis data stream.
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
data HashKeyRange Source #
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
See: newHashKeyRange smart constructor.
Constructors
| HashKeyRange' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> HashKeyRange |
Create a value of HashKeyRange 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:startingHashKey:HashKeyRange', hashKeyRange_startingHashKey - The starting hash key of the hash key range.
$sel:endingHashKey:HashKeyRange', hashKeyRange_endingHashKey - The ending hash key of the hash key range.
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
data PutRecordsRequestEntry Source #
Represents the output for PutRecords.
See: newPutRecordsRequestEntry smart constructor.
Constructors
| PutRecordsRequestEntry' | |
Fields
| |
Instances
newPutRecordsRequestEntry Source #
Arguments
| :: ByteString | |
| -> Text | |
| -> PutRecordsRequestEntry |
Create a value of PutRecordsRequestEntry 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:explicitHashKey:PutRecordsRequestEntry', putRecordsRequestEntry_explicitHashKey - The hash value used to determine explicitly the shard that the data
record is assigned to by overriding the partition key hash.
$sel:data':PutRecordsRequestEntry', putRecordsRequestEntry_data - 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.
$sel:partitionKey:PutRecordsRequestEntry', putRecordsRequestEntry_partitionKey - 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.
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
data PutRecordsResultEntry Source #
Represents the result of an individual record from a PutRecords
request. A record that is successfully added to a stream includes
SequenceNumber and ShardId in the result. A record that fails to be
added to the stream includes ErrorCode and ErrorMessage in the
result.
See: newPutRecordsResultEntry smart constructor.
Constructors
| PutRecordsResultEntry' | |
Fields
| |
Instances
newPutRecordsResultEntry :: PutRecordsResultEntry Source #
Create a value of PutRecordsResultEntry 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:errorCode:PutRecordsResultEntry', putRecordsResultEntry_errorCode - The error code for an individual record result. ErrorCodes can be
either ProvisionedThroughputExceededException or InternalFailure.
$sel:errorMessage:PutRecordsResultEntry', putRecordsResultEntry_errorMessage - 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".
$sel:sequenceNumber:PutRecordsResultEntry', putRecordsResultEntry_sequenceNumber - The sequence number for an individual record result.
$sel:shardId:PutRecordsResultEntry', putRecordsResultEntry_shardId - The shard ID for an individual record result.
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
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
See: newRecord smart constructor.
Constructors
| Record' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ByteString | |
| -> Text | |
| -> Record |
Create a value of Record 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:approximateArrivalTimestamp:Record', record_approximateArrivalTimestamp - The approximate time that the record was inserted into the stream.
$sel:encryptionType:Record', record_encryptionType - 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.
$sel:sequenceNumber:Record', record_sequenceNumber - The unique identifier of the record within its shard.
$sel:data':Record', record_data - 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.
$sel:partitionKey:Record', record_partitionKey - Identifies which shard in the stream the data record is assigned to.
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
data SequenceNumberRange Source #
The range of possible sequence numbers for the shard.
See: newSequenceNumberRange smart constructor.
Constructors
| SequenceNumberRange' | |
Fields
| |
Instances
newSequenceNumberRange Source #
Create a value of SequenceNumberRange 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:endingSequenceNumber:SequenceNumberRange', sequenceNumberRange_endingSequenceNumber - The ending sequence number for the range. Shards that are in the OPEN
state have an ending sequence number of null.
$sel:startingSequenceNumber:SequenceNumberRange', sequenceNumberRange_startingSequenceNumber - The starting sequence number for the range.
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
A uniquely identified group of data records in a Kinesis data stream.
See: newShard smart constructor.
Constructors
| Shard' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> HashKeyRange | |
| -> SequenceNumberRange | |
| -> Shard |
Create a value of Shard 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:adjacentParentShardId:Shard', shard_adjacentParentShardId - The shard ID of the shard adjacent to the shard's parent.
$sel:parentShardId:Shard', shard_parentShardId - The shard ID of the shard's parent.
$sel:shardId:Shard', shard_shardId - The unique identifier of the shard within the stream.
$sel:hashKeyRange:Shard', shard_hashKeyRange - The range of possible hash key values for the shard, which is a set of
ordered contiguous positive integers.
$sel:sequenceNumberRange:Shard', shard_sequenceNumberRange - The range of possible sequence numbers for the 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
data ShardFilter Source #
The request parameter used to filter out the response of the
ListShards API.
See: newShardFilter smart constructor.
Constructors
| ShardFilter' | |
Fields
| |
Instances
Arguments
| :: ShardFilterType | |
| -> 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 theShardIdthat 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_HORIZONof the data stream ifFROM_TIMESTAMPis less than theTRIM_HORIZONvalue.
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 theShardIdthat 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_HORIZONof the data stream ifFROM_TIMESTAMPis less than theTRIM_HORIZONvalue.
StartingPosition
data StartingPosition Source #
The starting position in the data stream from which to start streaming.
See: newStartingPosition smart constructor.
Constructors
| StartingPosition' | |
Fields
| |
Instances
Create a value of StartingPosition 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:sequenceNumber:StartingPosition', startingPosition_sequenceNumber - 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.
$sel:timestamp:StartingPosition', startingPosition_timestamp - 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).
$sel:type':StartingPosition', startingPosition_type - 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.
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
data StreamDescription Source #
Represents the output for DescribeStream.
See: newStreamDescription smart constructor.
Constructors
| StreamDescription' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StreamStatus | |
| -> Bool | |
| -> Int | |
| -> UTCTime | |
| -> StreamDescription |
Create a value of StreamDescription 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:encryptionType:StreamDescription', streamDescription_encryptionType - 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.
$sel:keyId:StreamDescription', streamDescription_keyId - 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
$sel:streamModeDetails:StreamDescription', streamDescription_streamModeDetails - 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.
$sel:streamName:StreamDescription', streamDescription_streamName - The name of the stream being described.
$sel:streamARN:StreamDescription', streamDescription_streamARN - The Amazon Resource Name (ARN) for the stream being described.
$sel:streamStatus:StreamDescription', streamDescription_streamStatus - 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 setsStreamStatustoCREATING.DELETING- The stream is being deleted. The specified stream is in theDELETINGstate 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 anACTIVEstream.UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
$sel:shards:StreamDescription', streamDescription_shards - The shards that comprise the stream.
$sel:hasMoreShards:StreamDescription', streamDescription_hasMoreShards - If set to true, more shards in the stream are available to describe.
$sel:retentionPeriodHours:StreamDescription', streamDescription_retentionPeriodHours - The current retention period, in hours. Minimum value of 24. Maximum
value of 168.
$sel:streamCreationTimestamp:StreamDescription', streamDescription_streamCreationTimestamp - The approximate time that the stream was created.
$sel:enhancedMonitoring:StreamDescription', streamDescription_enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
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 setsStreamStatustoCREATING.DELETING- The stream is being deleted. The specified stream is in theDELETINGstate 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 anACTIVEstream.UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
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
data StreamDescriptionSummary Source #
Represents the output for DescribeStreamSummary
See: newStreamDescriptionSummary smart constructor.
Constructors
| StreamDescriptionSummary' | |
Fields
| |
Instances
newStreamDescriptionSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> StreamStatus | |
| -> Int | |
| -> UTCTime | |
| -> Natural | |
| -> StreamDescriptionSummary |
Create a value of StreamDescriptionSummary 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:consumerCount:StreamDescriptionSummary', streamDescriptionSummary_consumerCount - The number of enhanced fan-out consumers registered with the stream.
$sel:encryptionType:StreamDescriptionSummary', streamDescriptionSummary_encryptionType - The encryption type used. This value is one of the following:
KMS
NONE
$sel:keyId:StreamDescriptionSummary', streamDescriptionSummary_keyId - 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
$sel:streamModeDetails:StreamDescriptionSummary', streamDescriptionSummary_streamModeDetails - 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.
$sel:streamName:StreamDescriptionSummary', streamDescriptionSummary_streamName - The name of the stream being described.
$sel:streamARN:StreamDescriptionSummary', streamDescriptionSummary_streamARN - The Amazon Resource Name (ARN) for the stream being described.
$sel:streamStatus:StreamDescriptionSummary', streamDescriptionSummary_streamStatus - 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 setsStreamStatustoCREATING.DELETING- The stream is being deleted. The specified stream is in theDELETINGstate 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 anACTIVEstream.UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
$sel:retentionPeriodHours:StreamDescriptionSummary', streamDescriptionSummary_retentionPeriodHours - The current retention period, in hours.
$sel:streamCreationTimestamp:StreamDescriptionSummary', streamDescriptionSummary_streamCreationTimestamp - The approximate time that the stream was created.
$sel:enhancedMonitoring:StreamDescriptionSummary', streamDescriptionSummary_enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
$sel:openShardCount:StreamDescriptionSummary', streamDescriptionSummary_openShardCount - The number of open shards in the stream.
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 setsStreamStatustoCREATING.DELETING- The stream is being deleted. The specified stream is in theDELETINGstate 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 anACTIVEstream.UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
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
data 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.
See: newStreamModeDetails smart constructor.
Constructors
| StreamModeDetails' | |
Fields
| |
Instances
Create a value of StreamModeDetails 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:streamMode:StreamModeDetails', streamModeDetails_streamMode - 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.
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
data StreamSummary Source #
The summary of a stream.
See: newStreamSummary smart constructor.
Constructors
| StreamSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StreamStatus | |
| -> StreamSummary |
Create a value of StreamSummary 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:streamCreationTimestamp:StreamSummary', streamSummary_streamCreationTimestamp - The timestamp at which the stream was created.
$sel:streamModeDetails:StreamSummary', streamSummary_streamModeDetails - Undocumented member.
$sel:streamName:StreamSummary', streamSummary_streamName - The name of a stream.
$sel:streamARN:StreamSummary', streamSummary_streamARN - The ARN of the stream.
$sel:streamStatus:StreamSummary', streamSummary_streamStatus - The status of the stream.
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
data SubscribeToShardEvent Source #
After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.
See: newSubscribeToShardEvent smart constructor.
Constructors
| SubscribeToShardEvent' | |
Fields
| |
Instances
newSubscribeToShardEvent Source #
Arguments
| :: Text | |
| -> Natural | |
| -> SubscribeToShardEvent |
Create a value of SubscribeToShardEvent 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:childShards:SubscribeToShardEvent', subscribeToShardEvent_childShards - The list of the child shards of the current shard, returned only at the
end of the current shard.
$sel:records:SubscribeToShardEvent', subscribeToShardEvent_records -
$sel:continuationSequenceNumber:SubscribeToShardEvent', subscribeToShardEvent_continuationSequenceNumber - 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.
$sel:millisBehindLatest:SubscribeToShardEvent', subscribeToShardEvent_millisBehindLatest - 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.
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.
Tag
Metadata assigned to the stream, consisting of a key-value pair.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| FromJSON Tag Source # | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Kinesis.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Kinesis.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Kinesis.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Kinesis.Types.Tag" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:value:Tag', tag_value - An optional string, typically used to describe or define the tag.
Maximum length: 256 characters. Valid characters: Unicode letters,
digits, white space, _ . / = + - % @
$sel:key:Tag', tag_key - A unique identifier for the tag. Maximum length: 128 characters. Valid
characters: Unicode letters, digits, white space, _ . / = + - % @