| 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
Contents
- Service Configuration
- Errors
- AccessDeniedException
- ExpiredIteratorException
- ExpiredNextTokenException
- InternalFailureException
- InvalidArgumentException
- KMSAccessDeniedException
- KMSDisabledException
- KMSInvalidStateException
- KMSNotFoundException
- KMSOptInRequired
- KMSThrottlingException
- LimitExceededException
- ProvisionedThroughputExceededException
- ResourceInUseException
- ResourceNotFoundException
- ValidationException
- Waiters
- Operations
- AddTagsToStream
- CreateStream
- DecreaseStreamRetentionPeriod
- DeleteStream
- DeregisterStreamConsumer
- DescribeLimits
- DescribeStream (Paginated)
- DescribeStreamConsumer
- DescribeStreamSummary
- DisableEnhancedMonitoring
- EnableEnhancedMonitoring
- GetRecords
- GetShardIterator
- IncreaseStreamRetentionPeriod
- ListShards (Paginated)
- ListStreamConsumers (Paginated)
- ListStreams (Paginated)
- ListTagsForStream
- MergeShards
- PutRecord
- PutRecords
- RegisterStreamConsumer
- RemoveTagsFromStream
- SplitShard
- StartStreamEncryption
- StopStreamEncryption
- SubscribeToShard
- UpdateShardCount
- UpdateStreamMode
- Types
- 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
Derived from API version 2013-12-02 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Kinesis Data Streams Service API Reference
Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.
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
- newStreamExists :: Wait DescribeStream
- newStreamNotExists :: Wait DescribeStream
- data AddTagsToStream = AddTagsToStream' (Maybe Text) (Maybe Text) (HashMap Text Text)
- newAddTagsToStream :: AddTagsToStream
- data AddTagsToStreamResponse = AddTagsToStreamResponse' {
- newAddTagsToStreamResponse :: AddTagsToStreamResponse
- data CreateStream = CreateStream' (Maybe Natural) (Maybe StreamModeDetails) Text
- newCreateStream :: Text -> CreateStream
- data CreateStreamResponse = CreateStreamResponse' {
- newCreateStreamResponse :: CreateStreamResponse
- data DecreaseStreamRetentionPeriod = DecreaseStreamRetentionPeriod' (Maybe Text) (Maybe Text) Int
- newDecreaseStreamRetentionPeriod :: Int -> DecreaseStreamRetentionPeriod
- data DecreaseStreamRetentionPeriodResponse = DecreaseStreamRetentionPeriodResponse' {
- newDecreaseStreamRetentionPeriodResponse :: DecreaseStreamRetentionPeriodResponse
- data DeleteStream = DeleteStream' (Maybe Bool) (Maybe Text) (Maybe Text)
- newDeleteStream :: DeleteStream
- data DeleteStreamResponse = DeleteStreamResponse' {
- newDeleteStreamResponse :: DeleteStreamResponse
- data DeregisterStreamConsumer = DeregisterStreamConsumer' (Maybe Text) (Maybe Text) (Maybe Text)
- newDeregisterStreamConsumer :: DeregisterStreamConsumer
- data DeregisterStreamConsumerResponse = DeregisterStreamConsumerResponse' {
- newDeregisterStreamConsumerResponse :: DeregisterStreamConsumerResponse
- data DescribeLimits = DescribeLimits' {
- newDescribeLimits :: DescribeLimits
- data DescribeLimitsResponse = DescribeLimitsResponse' Int Natural Natural Natural Natural
- newDescribeLimitsResponse :: Int -> Natural -> Natural -> Natural -> Natural -> DescribeLimitsResponse
- data DescribeStream = DescribeStream' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeStream :: DescribeStream
- data DescribeStreamResponse = DescribeStreamResponse' Int StreamDescription
- newDescribeStreamResponse :: Int -> StreamDescription -> DescribeStreamResponse
- data DescribeStreamConsumer = DescribeStreamConsumer' (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeStreamConsumer :: DescribeStreamConsumer
- data DescribeStreamConsumerResponse = DescribeStreamConsumerResponse' Int ConsumerDescription
- newDescribeStreamConsumerResponse :: Int -> ConsumerDescription -> DescribeStreamConsumerResponse
- data DescribeStreamSummary = DescribeStreamSummary' (Maybe Text) (Maybe Text)
- newDescribeStreamSummary :: DescribeStreamSummary
- data DescribeStreamSummaryResponse = DescribeStreamSummaryResponse' Int StreamDescriptionSummary
- newDescribeStreamSummaryResponse :: Int -> StreamDescriptionSummary -> DescribeStreamSummaryResponse
- data DisableEnhancedMonitoring = DisableEnhancedMonitoring' (Maybe Text) (Maybe Text) [MetricsName]
- newDisableEnhancedMonitoring :: DisableEnhancedMonitoring
- data EnhancedMonitoringOutput = EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text) (Maybe Text)
- newEnhancedMonitoringOutput :: EnhancedMonitoringOutput
- data EnableEnhancedMonitoring = EnableEnhancedMonitoring' (Maybe Text) (Maybe Text) [MetricsName]
- newEnableEnhancedMonitoring :: EnableEnhancedMonitoring
- data EnhancedMonitoringOutput = EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text) (Maybe Text)
- newEnhancedMonitoringOutput :: EnhancedMonitoringOutput
- data GetRecords = GetRecords' (Maybe Natural) (Maybe Text) Text
- newGetRecords :: Text -> GetRecords
- data GetRecordsResponse = GetRecordsResponse' (Maybe [ChildShard]) (Maybe Natural) (Maybe Text) Int [Record]
- newGetRecordsResponse :: Int -> GetRecordsResponse
- data GetShardIterator = GetShardIterator' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Text ShardIteratorType
- newGetShardIterator :: Text -> ShardIteratorType -> GetShardIterator
- data GetShardIteratorResponse = GetShardIteratorResponse' (Maybe Text) Int
- newGetShardIteratorResponse :: Int -> GetShardIteratorResponse
- data IncreaseStreamRetentionPeriod = IncreaseStreamRetentionPeriod' (Maybe Text) (Maybe Text) Int
- newIncreaseStreamRetentionPeriod :: Int -> IncreaseStreamRetentionPeriod
- data IncreaseStreamRetentionPeriodResponse = IncreaseStreamRetentionPeriodResponse' {
- newIncreaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse
- data ListShards = ListShards' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ShardFilter) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newListShards :: ListShards
- data ListShardsResponse = ListShardsResponse' (Maybe Text) (Maybe [Shard]) Int
- newListShardsResponse :: Int -> ListShardsResponse
- data ListStreamConsumers = ListStreamConsumers' (Maybe Natural) (Maybe Text) (Maybe POSIX) Text
- newListStreamConsumers :: Text -> ListStreamConsumers
- data ListStreamConsumersResponse = ListStreamConsumersResponse' (Maybe [Consumer]) (Maybe Text) Int
- newListStreamConsumersResponse :: Int -> ListStreamConsumersResponse
- data ListStreams = ListStreams' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListStreams :: ListStreams
- data ListStreamsResponse = ListStreamsResponse' (Maybe Text) (Maybe [StreamSummary]) Int [Text] Bool
- newListStreamsResponse :: Int -> Bool -> ListStreamsResponse
- data ListTagsForStream = ListTagsForStream' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text)
- newListTagsForStream :: ListTagsForStream
- data ListTagsForStreamResponse = ListTagsForStreamResponse' Int [Tag] Bool
- newListTagsForStreamResponse :: Int -> Bool -> ListTagsForStreamResponse
- data MergeShards = MergeShards' (Maybe Text) (Maybe Text) Text Text
- newMergeShards :: Text -> Text -> MergeShards
- data MergeShardsResponse = MergeShardsResponse' {
- newMergeShardsResponse :: MergeShardsResponse
- data PutRecord = PutRecord' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Base64 Text
- newPutRecord :: ByteString -> Text -> PutRecord
- data PutRecordResponse = PutRecordResponse' (Maybe EncryptionType) Int Text Text
- newPutRecordResponse :: Int -> Text -> Text -> PutRecordResponse
- data PutRecords = PutRecords' (Maybe Text) (Maybe Text) (NonEmpty PutRecordsRequestEntry)
- newPutRecords :: NonEmpty PutRecordsRequestEntry -> PutRecords
- data PutRecordsResponse = PutRecordsResponse' (Maybe EncryptionType) (Maybe Natural) Int (NonEmpty PutRecordsResultEntry)
- newPutRecordsResponse :: Int -> NonEmpty PutRecordsResultEntry -> PutRecordsResponse
- data RegisterStreamConsumer = RegisterStreamConsumer' Text Text
- newRegisterStreamConsumer :: Text -> Text -> RegisterStreamConsumer
- data RegisterStreamConsumerResponse = RegisterStreamConsumerResponse' Int Consumer
- newRegisterStreamConsumerResponse :: Int -> Consumer -> RegisterStreamConsumerResponse
- data RemoveTagsFromStream = RemoveTagsFromStream' (Maybe Text) (Maybe Text) (NonEmpty Text)
- newRemoveTagsFromStream :: NonEmpty Text -> RemoveTagsFromStream
- data RemoveTagsFromStreamResponse = RemoveTagsFromStreamResponse' {
- newRemoveTagsFromStreamResponse :: RemoveTagsFromStreamResponse
- data SplitShard = SplitShard' (Maybe Text) (Maybe Text) Text Text
- newSplitShard :: Text -> Text -> SplitShard
- data SplitShardResponse = SplitShardResponse' {
- newSplitShardResponse :: SplitShardResponse
- data StartStreamEncryption = StartStreamEncryption' (Maybe Text) (Maybe Text) EncryptionType Text
- newStartStreamEncryption :: EncryptionType -> Text -> StartStreamEncryption
- data StartStreamEncryptionResponse = StartStreamEncryptionResponse' {
- newStartStreamEncryptionResponse :: StartStreamEncryptionResponse
- data StopStreamEncryption = StopStreamEncryption' (Maybe Text) (Maybe Text) EncryptionType Text
- newStopStreamEncryption :: EncryptionType -> Text -> StopStreamEncryption
- data StopStreamEncryptionResponse = StopStreamEncryptionResponse' {
- newStopStreamEncryptionResponse :: StopStreamEncryptionResponse
- data SubscribeToShard = SubscribeToShard' Text Text StartingPosition
- newSubscribeToShard :: Text -> Text -> StartingPosition -> SubscribeToShard
- data SubscribeToShardResponse = SubscribeToShardResponse' Int Value
- newSubscribeToShardResponse :: Int -> Value -> SubscribeToShardResponse
- data UpdateShardCount = UpdateShardCount' (Maybe Text) (Maybe Text) Natural ScalingType
- newUpdateShardCount :: Natural -> ScalingType -> UpdateShardCount
- data UpdateShardCountResponse = UpdateShardCountResponse' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural) Int
- newUpdateShardCountResponse :: Int -> UpdateShardCountResponse
- data UpdateStreamMode = UpdateStreamMode' Text StreamModeDetails
- newUpdateStreamMode :: Text -> StreamModeDetails -> UpdateStreamMode
- data UpdateStreamModeResponse = UpdateStreamModeResponse' {
- newUpdateStreamModeResponse :: UpdateStreamModeResponse
- 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' Text [Text] HashKeyRange
- newChildShard :: Text -> HashKeyRange -> ChildShard
- data Consumer = Consumer' Text Text ConsumerStatus POSIX
- newConsumer :: Text -> Text -> ConsumerStatus -> UTCTime -> Consumer
- data ConsumerDescription = ConsumerDescription' Text Text ConsumerStatus POSIX Text
- newConsumerDescription :: Text -> Text -> ConsumerStatus -> UTCTime -> Text -> ConsumerDescription
- data EnhancedMetrics = EnhancedMetrics' (Maybe [MetricsName])
- newEnhancedMetrics :: EnhancedMetrics
- data EnhancedMonitoringOutput = EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text) (Maybe Text)
- newEnhancedMonitoringOutput :: EnhancedMonitoringOutput
- data HashKeyRange = HashKeyRange' Text Text
- newHashKeyRange :: Text -> Text -> HashKeyRange
- data PutRecordsRequestEntry = PutRecordsRequestEntry' (Maybe Text) Base64 Text
- newPutRecordsRequestEntry :: ByteString -> Text -> PutRecordsRequestEntry
- data PutRecordsResultEntry = PutRecordsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPutRecordsResultEntry :: PutRecordsResultEntry
- data Record = Record' (Maybe POSIX) (Maybe EncryptionType) Text Base64 Text
- newRecord :: Text -> ByteString -> Text -> Record
- data SequenceNumberRange = SequenceNumberRange' (Maybe Text) Text
- newSequenceNumberRange :: Text -> SequenceNumberRange
- data Shard = Shard' (Maybe Text) (Maybe Text) Text HashKeyRange SequenceNumberRange
- newShard :: Text -> HashKeyRange -> SequenceNumberRange -> Shard
- data ShardFilter = ShardFilter' (Maybe Text) (Maybe POSIX) ShardFilterType
- newShardFilter :: ShardFilterType -> ShardFilter
- data StartingPosition = StartingPosition' (Maybe Text) (Maybe POSIX) ShardIteratorType
- newStartingPosition :: ShardIteratorType -> StartingPosition
- data StreamDescription = StreamDescription' (Maybe EncryptionType) (Maybe Text) (Maybe StreamModeDetails) Text Text StreamStatus [Shard] Bool Int POSIX [EnhancedMetrics]
- newStreamDescription :: Text -> Text -> StreamStatus -> Bool -> Int -> UTCTime -> StreamDescription
- data StreamDescriptionSummary = StreamDescriptionSummary' (Maybe Natural) (Maybe EncryptionType) (Maybe Text) (Maybe StreamModeDetails) Text Text StreamStatus Int POSIX [EnhancedMetrics] Natural
- newStreamDescriptionSummary :: Text -> Text -> StreamStatus -> Int -> UTCTime -> Natural -> StreamDescriptionSummary
- data StreamModeDetails = StreamModeDetails' StreamMode
- newStreamModeDetails :: StreamMode -> StreamModeDetails
- data StreamSummary = StreamSummary' (Maybe POSIX) (Maybe StreamModeDetails) Text Text StreamStatus
- newStreamSummary :: Text -> Text -> StreamStatus -> StreamSummary
- data SubscribeToShardEvent = SubscribeToShardEvent' (Maybe [ChildShard]) [Record] Text Natural
- newSubscribeToShardEvent :: Text -> Natural -> SubscribeToShardEvent
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2013-12-02 of the Amazon Kinesis SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Kinesis.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Specifies that you do not have the permissions required to perform this operation.
ExpiredIteratorException
_ExpiredIteratorException :: AsError a => Fold a ServiceError Source #
The provided iterator exceeds the maximum age allowed.
ExpiredNextTokenException
_ExpiredNextTokenException :: AsError a => Fold a ServiceError Source #
The pagination token passed to the operation is expired.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
The processing of the request failed because of an unknown error, exception, or failure.
InvalidArgumentException
_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
_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
_KMSDisabledException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified customer master key (CMK) isn't enabled.
KMSInvalidStateException
_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
_KMSNotFoundException :: AsError a => Fold a ServiceError Source #
The request was rejected because the specified entity or resource can't be found.
KMSOptInRequired
_KMSOptInRequired :: AsError a => Fold a ServiceError Source #
The Amazon Web Services access key ID needs a subscription for the service.
KMSThrottlingException
_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
_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
_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
_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
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource could not be found. The stream might not be specified correctly.
ValidationException
_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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
StreamExists
newStreamExists :: Wait DescribeStream Source #
Polls DescribeStream every 10 seconds until a successful state is reached. An error is returned after 18 failed checks.
StreamNotExists
newStreamNotExists :: Wait DescribeStream Source #
Polls DescribeStream every 10 seconds until a successful state is reached. An error is returned after 18 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AddTagsToStream
data AddTagsToStream Source #
Represents the input for AddTagsToStream.
See: newAddTagsToStream smart constructor.
Instances
newAddTagsToStream :: AddTagsToStream Source #
Create a value of AddTagsToStream 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:
AddTagsToStream, addTagsToStream_streamARN - The ARN of the stream.
AddTagsToStream, addTagsToStream_streamName - The name of the stream.
$sel:tags:AddTagsToStream', addTagsToStream_tags - A set of up to 10 key-value pairs to use to create the tags.
data AddTagsToStreamResponse Source #
See: newAddTagsToStreamResponse smart constructor.
Constructors
| AddTagsToStreamResponse' | |
Instances
newAddTagsToStreamResponse :: AddTagsToStreamResponse Source #
Create a value of AddTagsToStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateStream
data CreateStream Source #
Represents the input for CreateStream.
See: newCreateStream smart constructor.
Constructors
| CreateStream' (Maybe Natural) (Maybe StreamModeDetails) Text |
Instances
Arguments
| :: Text | |
| -> CreateStream |
Create a value of CreateStream 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:shardCount:CreateStream', createStream_shardCount - 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, createStream_streamModeDetails - 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, createStream_streamName - 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.
data CreateStreamResponse Source #
See: newCreateStreamResponse smart constructor.
Constructors
| CreateStreamResponse' | |
Instances
newCreateStreamResponse :: CreateStreamResponse Source #
Create a value of CreateStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DecreaseStreamRetentionPeriod
data DecreaseStreamRetentionPeriod Source #
Represents the input for DecreaseStreamRetentionPeriod.
See: newDecreaseStreamRetentionPeriod smart constructor.
Instances
newDecreaseStreamRetentionPeriod Source #
Create a value of DecreaseStreamRetentionPeriod 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:
DecreaseStreamRetentionPeriod, decreaseStreamRetentionPeriod_streamARN - The ARN of the stream.
DecreaseStreamRetentionPeriod, decreaseStreamRetentionPeriod_streamName - The name of the stream to modify.
DecreaseStreamRetentionPeriod, decreaseStreamRetentionPeriod_retentionPeriodHours - The new retention period of the stream, in hours. Must be less than the
current retention period.
data DecreaseStreamRetentionPeriodResponse Source #
See: newDecreaseStreamRetentionPeriodResponse smart constructor.
Constructors
| DecreaseStreamRetentionPeriodResponse' | |
Instances
newDecreaseStreamRetentionPeriodResponse :: DecreaseStreamRetentionPeriodResponse Source #
Create a value of DecreaseStreamRetentionPeriodResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteStream
data DeleteStream Source #
Represents the input for DeleteStream.
See: newDeleteStream smart constructor.
Instances
newDeleteStream :: DeleteStream Source #
Create a value of DeleteStream 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:enforceConsumerDeletion:DeleteStream', deleteStream_enforceConsumerDeletion - 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, deleteStream_streamARN - The ARN of the stream.
DeleteStream, deleteStream_streamName - The name of the stream to delete.
data DeleteStreamResponse Source #
See: newDeleteStreamResponse smart constructor.
Constructors
| DeleteStreamResponse' | |
Instances
newDeleteStreamResponse :: DeleteStreamResponse Source #
Create a value of DeleteStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeregisterStreamConsumer
data DeregisterStreamConsumer Source #
See: newDeregisterStreamConsumer smart constructor.
Instances
newDeregisterStreamConsumer :: DeregisterStreamConsumer Source #
Create a value of DeregisterStreamConsumer 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:
DeregisterStreamConsumer, deregisterStreamConsumer_consumerARN - 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, deregisterStreamConsumer_consumerName - The name that you gave to the consumer.
DeregisterStreamConsumer, deregisterStreamConsumer_streamARN - 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.
data DeregisterStreamConsumerResponse Source #
See: newDeregisterStreamConsumerResponse smart constructor.
Constructors
| DeregisterStreamConsumerResponse' | |
Instances
| Generic DeregisterStreamConsumerResponse Source # | |
Defined in Amazonka.Kinesis.DeregisterStreamConsumer Associated Types type Rep DeregisterStreamConsumerResponse :: Type -> Type # | |
| Read DeregisterStreamConsumerResponse Source # | |
| Show DeregisterStreamConsumerResponse Source # | |
Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods showsPrec :: Int -> DeregisterStreamConsumerResponse -> ShowS # | |
| NFData DeregisterStreamConsumerResponse Source # | |
Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods rnf :: DeregisterStreamConsumerResponse -> () # | |
| Eq DeregisterStreamConsumerResponse Source # | |
| type Rep DeregisterStreamConsumerResponse Source # | |
Defined in Amazonka.Kinesis.DeregisterStreamConsumer | |
newDeregisterStreamConsumerResponse :: DeregisterStreamConsumerResponse Source #
Create a value of DeregisterStreamConsumerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeLimits
data DescribeLimits Source #
See: newDescribeLimits smart constructor.
Constructors
| DescribeLimits' | |
Instances
newDescribeLimits :: DescribeLimits Source #
Create a value of DescribeLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeLimitsResponse Source #
See: newDescribeLimitsResponse smart constructor.
Instances
newDescribeLimitsResponse Source #
Create a value of DescribeLimitsResponse 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:httpStatus:DescribeLimitsResponse', describeLimitsResponse_httpStatus - The response's http status code.
$sel:shardLimit:DescribeLimitsResponse', describeLimitsResponse_shardLimit - The maximum number of shards.
DescribeLimitsResponse, describeLimitsResponse_openShardCount - The number of open shards.
$sel:onDemandStreamCount:DescribeLimitsResponse', describeLimitsResponse_onDemandStreamCount - Indicates the number of data streams with the on-demand capacity mode.
$sel:onDemandStreamCountLimit:DescribeLimitsResponse', describeLimitsResponse_onDemandStreamCountLimit - The maximum number of data streams with the on-demand capacity mode.
DescribeStream (Paginated)
data DescribeStream Source #
Represents the input for DescribeStream.
See: newDescribeStream smart constructor.
Instances
newDescribeStream :: DescribeStream Source #
Create a value of DescribeStream 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:exclusiveStartShardId:DescribeStream', describeStream_exclusiveStartShardId - 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.
$sel:limit:DescribeStream', describeStream_limit - 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, describeStream_streamARN - The ARN of the stream.
DescribeStream, describeStream_streamName - The name of the stream to describe.
data DescribeStreamResponse Source #
Represents the output for DescribeStream.
See: newDescribeStreamResponse smart constructor.
Constructors
| DescribeStreamResponse' Int StreamDescription |
Instances
newDescribeStreamResponse Source #
Arguments
| :: Int | |
| -> StreamDescription | |
| -> DescribeStreamResponse |
Create a value of DescribeStreamResponse 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:httpStatus:DescribeStreamResponse', describeStreamResponse_httpStatus - The response's http status code.
$sel:streamDescription:DescribeStreamResponse', describeStreamResponse_streamDescription - 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
data DescribeStreamConsumer Source #
See: newDescribeStreamConsumer smart constructor.
Instances
newDescribeStreamConsumer :: DescribeStreamConsumer Source #
Create a value of DescribeStreamConsumer 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:
DescribeStreamConsumer, describeStreamConsumer_consumerARN - The ARN returned by Kinesis Data Streams when you registered the
consumer.
DescribeStreamConsumer, describeStreamConsumer_consumerName - The name that you gave to the consumer.
DescribeStreamConsumer, describeStreamConsumer_streamARN - 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.
data DescribeStreamConsumerResponse Source #
See: newDescribeStreamConsumerResponse smart constructor.
Constructors
| DescribeStreamConsumerResponse' Int ConsumerDescription |
Instances
newDescribeStreamConsumerResponse Source #
Arguments
| :: Int | |
| -> ConsumerDescription | |
| -> DescribeStreamConsumerResponse |
Create a value of DescribeStreamConsumerResponse 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:httpStatus:DescribeStreamConsumerResponse', describeStreamConsumerResponse_httpStatus - The response's http status code.
$sel:consumerDescription:DescribeStreamConsumerResponse', describeStreamConsumerResponse_consumerDescription - An object that represents the details of the consumer.
DescribeStreamSummary
data DescribeStreamSummary Source #
See: newDescribeStreamSummary smart constructor.
Constructors
| DescribeStreamSummary' (Maybe Text) (Maybe Text) |
Instances
newDescribeStreamSummary :: DescribeStreamSummary Source #
Create a value of DescribeStreamSummary 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:
DescribeStreamSummary, describeStreamSummary_streamARN - The ARN of the stream.
DescribeStreamSummary, describeStreamSummary_streamName - The name of the stream to describe.
data DescribeStreamSummaryResponse Source #
See: newDescribeStreamSummaryResponse smart constructor.
Instances
newDescribeStreamSummaryResponse Source #
Arguments
| :: Int | |
| -> StreamDescriptionSummary |
|
| -> DescribeStreamSummaryResponse |
Create a value of DescribeStreamSummaryResponse 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:httpStatus:DescribeStreamSummaryResponse', describeStreamSummaryResponse_httpStatus - The response's http status code.
$sel:streamDescriptionSummary:DescribeStreamSummaryResponse', describeStreamSummaryResponse_streamDescriptionSummary - A StreamDescriptionSummary containing information about the stream.
DisableEnhancedMonitoring
data DisableEnhancedMonitoring Source #
Represents the input for DisableEnhancedMonitoring.
See: newDisableEnhancedMonitoring smart constructor.
Constructors
| DisableEnhancedMonitoring' (Maybe Text) (Maybe Text) [MetricsName] |
Instances
newDisableEnhancedMonitoring :: DisableEnhancedMonitoring Source #
Create a value of DisableEnhancedMonitoring 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:
DisableEnhancedMonitoring, disableEnhancedMonitoring_streamARN - The ARN of the stream.
DisableEnhancedMonitoring, disableEnhancedMonitoring_streamName - The name of the Kinesis data stream for which to disable enhanced
monitoring.
DisableEnhancedMonitoring, disableEnhancedMonitoring_shardLevelMetrics - 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.
data EnhancedMonitoringOutput Source #
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
See: newEnhancedMonitoringOutput smart constructor.
Constructors
| EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text) (Maybe Text) |
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.
EnableEnhancedMonitoring
data EnableEnhancedMonitoring Source #
Represents the input for EnableEnhancedMonitoring.
See: newEnableEnhancedMonitoring smart constructor.
Constructors
| EnableEnhancedMonitoring' (Maybe Text) (Maybe Text) [MetricsName] |
Instances
newEnableEnhancedMonitoring :: EnableEnhancedMonitoring Source #
Create a value of EnableEnhancedMonitoring 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:
EnableEnhancedMonitoring, enableEnhancedMonitoring_streamARN - The ARN of the stream.
EnableEnhancedMonitoring, enableEnhancedMonitoring_streamName - The name of the stream for which to enable enhanced monitoring.
EnableEnhancedMonitoring, enableEnhancedMonitoring_shardLevelMetrics - 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.
data EnhancedMonitoringOutput Source #
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
See: newEnhancedMonitoringOutput smart constructor.
Constructors
| EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text) (Maybe Text) |
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.
GetRecords
data GetRecords Source #
Represents the input for GetRecords.
See: newGetRecords smart constructor.
Instances
Arguments
| :: Text | |
| -> GetRecords |
Create a value of GetRecords 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:limit:GetRecords', getRecords_limit - 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, getRecords_streamARN - The ARN of the stream.
$sel:shardIterator:GetRecords', getRecords_shardIterator - 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.
data GetRecordsResponse Source #
Represents the output for GetRecords.
See: newGetRecordsResponse smart constructor.
Constructors
| GetRecordsResponse' (Maybe [ChildShard]) (Maybe Natural) (Maybe Text) Int [Record] |
Instances
newGetRecordsResponse Source #
Arguments
| :: Int | |
| -> GetRecordsResponse |
Create a value of GetRecordsResponse 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:
GetRecordsResponse, getRecordsResponse_childShards - 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, getRecordsResponse_millisBehindLatest - 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.
$sel:nextShardIterator:GetRecordsResponse', getRecordsResponse_nextShardIterator - 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.
$sel:httpStatus:GetRecordsResponse', getRecordsResponse_httpStatus - The response's http status code.
GetRecordsResponse, getRecordsResponse_records - The data records retrieved from the shard.
GetShardIterator
data GetShardIterator Source #
Represents the input for GetShardIterator.
See: newGetShardIterator smart constructor.
Constructors
| GetShardIterator' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Text ShardIteratorType |
Instances
Arguments
| :: Text | |
| -> ShardIteratorType | |
| -> GetShardIterator |
Create a value of GetShardIterator 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:
GetShardIterator, getShardIterator_startingSequenceNumber - 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, getShardIterator_streamARN - The ARN of the stream.
GetShardIterator, getShardIterator_streamName - The name of the Amazon Kinesis data stream.
GetShardIterator, getShardIterator_timestamp - 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, getShardIterator_shardId - The shard ID of the Kinesis Data Streams shard to get the iterator for.
$sel:shardIteratorType:GetShardIterator', getShardIterator_shardIteratorType - 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.
data GetShardIteratorResponse Source #
Represents the output for GetShardIterator.
See: newGetShardIteratorResponse smart constructor.
Constructors
| GetShardIteratorResponse' (Maybe Text) Int |
Instances
newGetShardIteratorResponse Source #
Create a value of GetShardIteratorResponse 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:shardIterator:GetShardIteratorResponse', getShardIteratorResponse_shardIterator - 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.
$sel:httpStatus:GetShardIteratorResponse', getShardIteratorResponse_httpStatus - The response's http status code.
IncreaseStreamRetentionPeriod
data IncreaseStreamRetentionPeriod Source #
Represents the input for IncreaseStreamRetentionPeriod.
See: newIncreaseStreamRetentionPeriod smart constructor.
Instances
newIncreaseStreamRetentionPeriod Source #
Create a value of IncreaseStreamRetentionPeriod 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:
IncreaseStreamRetentionPeriod, increaseStreamRetentionPeriod_streamARN - The ARN of the stream.
IncreaseStreamRetentionPeriod, increaseStreamRetentionPeriod_streamName - The name of the stream to modify.
IncreaseStreamRetentionPeriod, increaseStreamRetentionPeriod_retentionPeriodHours - The new retention period of the stream, in hours. Must be more than the
current retention period.
data IncreaseStreamRetentionPeriodResponse Source #
See: newIncreaseStreamRetentionPeriodResponse smart constructor.
Constructors
| IncreaseStreamRetentionPeriodResponse' | |
Instances
newIncreaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse Source #
Create a value of IncreaseStreamRetentionPeriodResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListShards (Paginated)
data ListShards Source #
See: newListShards smart constructor.
Constructors
| ListShards' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ShardFilter) (Maybe Text) (Maybe POSIX) (Maybe Text) |
Instances
newListShards :: ListShards Source #
Create a value of ListShards 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:exclusiveStartShardId:ListShards', listShards_exclusiveStartShardId - 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.
$sel:maxResults:ListShards', listShards_maxResults - 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, listShards_nextToken - 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.
$sel:shardFilter:ListShards', listShards_shardFilter - 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, listShards_streamARN - The ARN of the stream.
ListShards, listShards_streamCreationTimestamp - 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, listShards_streamName - The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
data ListShardsResponse Source #
See: newListShardsResponse smart constructor.
Instances
newListShardsResponse Source #
Arguments
| :: Int | |
| -> ListShardsResponse |
Create a value of ListShardsResponse 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:
ListShards, listShardsResponse_nextToken - 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, listShardsResponse_shards - 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.
$sel:httpStatus:ListShardsResponse', listShardsResponse_httpStatus - The response's http status code.
ListStreamConsumers (Paginated)
data ListStreamConsumers Source #
See: newListStreamConsumers smart constructor.
Instances
newListStreamConsumers Source #
Arguments
| :: Text | |
| -> ListStreamConsumers |
Create a value of ListStreamConsumers 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:maxResults:ListStreamConsumers', listStreamConsumers_maxResults - 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, listStreamConsumers_nextToken - 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, listStreamConsumers_streamCreationTimestamp - 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, listStreamConsumers_streamARN - 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.
data ListStreamConsumersResponse Source #
See: newListStreamConsumersResponse smart constructor.
Instances
newListStreamConsumersResponse Source #
Create a value of ListStreamConsumersResponse 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:consumers:ListStreamConsumersResponse', listStreamConsumersResponse_consumers - An array of JSON objects. Each object represents one registered
consumer.
ListStreamConsumers, listStreamConsumersResponse_nextToken - 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.
$sel:httpStatus:ListStreamConsumersResponse', listStreamConsumersResponse_httpStatus - The response's http status code.
ListStreams (Paginated)
data ListStreams Source #
Represents the input for ListStreams.
See: newListStreams smart constructor.
Instances
newListStreams :: ListStreams Source #
Create a value of ListStreams 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:exclusiveStartStreamName:ListStreams', listStreams_exclusiveStartStreamName - The name of the stream to start the list with.
$sel:limit:ListStreams', listStreams_limit - 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.
data ListStreamsResponse Source #
Represents the output for ListStreams.
See: newListStreamsResponse smart constructor.
Constructors
| ListStreamsResponse' (Maybe Text) (Maybe [StreamSummary]) Int [Text] Bool |
Instances
newListStreamsResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> ListStreamsResponse |
Create a value of ListStreamsResponse 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:
ListStreams, listStreamsResponse_nextToken -
$sel:streamSummaries:ListStreamsResponse', listStreamsResponse_streamSummaries -
$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.
$sel:streamNames:ListStreamsResponse', listStreamsResponse_streamNames - The names of the streams that are associated with the Amazon Web
Services account making the ListStreams request.
$sel:hasMoreStreams:ListStreamsResponse', listStreamsResponse_hasMoreStreams - If set to true, there are more streams available to list.
ListTagsForStream
data ListTagsForStream Source #
Represents the input for ListTagsForStream.
See: newListTagsForStream smart constructor.
Instances
newListTagsForStream :: ListTagsForStream Source #
Create a value of ListTagsForStream 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:exclusiveStartTagKey:ListTagsForStream', listTagsForStream_exclusiveStartTagKey - 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.
$sel:limit:ListTagsForStream', listTagsForStream_limit - 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, listTagsForStream_streamARN - The ARN of the stream.
ListTagsForStream, listTagsForStream_streamName - The name of the stream.
data ListTagsForStreamResponse Source #
Represents the output for ListTagsForStream.
See: newListTagsForStreamResponse smart constructor.
Constructors
| ListTagsForStreamResponse' Int [Tag] Bool |
Instances
newListTagsForStreamResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> ListTagsForStreamResponse |
Create a value of ListTagsForStreamResponse 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:httpStatus:ListTagsForStreamResponse', listTagsForStreamResponse_httpStatus - The response's http status code.
$sel:tags:ListTagsForStreamResponse', listTagsForStreamResponse_tags - A list of tags associated with StreamName, starting with the first tag
after ExclusiveStartTagKey and up to the specified Limit.
$sel:hasMoreTags:ListTagsForStreamResponse', listTagsForStreamResponse_hasMoreTags - If set to true, more tags are available. To request additional tags,
set ExclusiveStartTagKey to the key of the last tag returned.
MergeShards
data MergeShards Source #
Represents the input for MergeShards.
See: newMergeShards smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MergeShards |
Create a value of MergeShards 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:
MergeShards, mergeShards_streamARN - The ARN of the stream.
MergeShards, mergeShards_streamName - The name of the stream for the merge.
$sel:shardToMerge:MergeShards', mergeShards_shardToMerge - The shard ID of the shard to combine with the adjacent shard for the
merge.
$sel:adjacentShardToMerge:MergeShards', mergeShards_adjacentShardToMerge - The shard ID of the adjacent shard for the merge.
data MergeShardsResponse Source #
See: newMergeShardsResponse smart constructor.
Constructors
| MergeShardsResponse' | |
Instances
newMergeShardsResponse :: MergeShardsResponse Source #
Create a value of MergeShardsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutRecord
Represents the input for PutRecord.
See: newPutRecord smart constructor.
Instances
Arguments
| :: ByteString | |
| -> Text | |
| -> PutRecord |
Create a value of PutRecord 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:
PutRecord, putRecord_explicitHashKey - The hash value used to explicitly determine the shard the data record is
assigned to by overriding the partition key hash.
$sel:sequenceNumberForOrdering:PutRecord', putRecord_sequenceNumberForOrdering - 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, putRecord_streamARN - The ARN of the stream.
PutRecord, putRecord_streamName - The name of the stream to put the data record into.
PutRecord, putRecord_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.
PutRecord, putRecord_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.
data PutRecordResponse Source #
Represents the output for PutRecord.
See: newPutRecordResponse smart constructor.
Constructors
| PutRecordResponse' (Maybe EncryptionType) Int Text Text |
Instances
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> PutRecordResponse |
Create a value of PutRecordResponse 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:
PutRecordResponse, putRecordResponse_encryptionType - 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.
$sel:httpStatus:PutRecordResponse', putRecordResponse_httpStatus - The response's http status code.
PutRecordResponse, putRecordResponse_shardId - The shard ID of the shard where the data record was placed.
PutRecordResponse, putRecordResponse_sequenceNumber - 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
data PutRecords Source #
A PutRecords request.
See: newPutRecords smart constructor.
Constructors
| PutRecords' (Maybe Text) (Maybe Text) (NonEmpty PutRecordsRequestEntry) |
Instances
Arguments
| :: NonEmpty PutRecordsRequestEntry | |
| -> PutRecords |
Create a value of PutRecords 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:
PutRecords, putRecords_streamARN - The ARN of the stream.
PutRecords, putRecords_streamName - The stream name associated with the request.
PutRecords, putRecords_records - The records associated with the request.
data PutRecordsResponse Source #
PutRecords results.
See: newPutRecordsResponse smart constructor.
Constructors
| PutRecordsResponse' (Maybe EncryptionType) (Maybe Natural) Int (NonEmpty PutRecordsResultEntry) |
Instances
newPutRecordsResponse Source #
Arguments
| :: Int | |
| -> NonEmpty PutRecordsResultEntry | |
| -> PutRecordsResponse |
Create a value of PutRecordsResponse 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:
PutRecordsResponse, putRecordsResponse_encryptionType - 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.
$sel:failedRecordCount:PutRecordsResponse', putRecordsResponse_failedRecordCount - The number of unsuccessfully processed records in a PutRecords
request.
$sel:httpStatus:PutRecordsResponse', putRecordsResponse_httpStatus - The response's http status code.
PutRecords, putRecordsResponse_records - 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
data RegisterStreamConsumer Source #
See: newRegisterStreamConsumer smart constructor.
Constructors
| RegisterStreamConsumer' Text Text |
Instances
newRegisterStreamConsumer Source #
Create a value of RegisterStreamConsumer 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:
RegisterStreamConsumer, registerStreamConsumer_streamARN - 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, registerStreamConsumer_consumerName - 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.
data RegisterStreamConsumerResponse Source #
See: newRegisterStreamConsumerResponse smart constructor.
Constructors
| RegisterStreamConsumerResponse' Int Consumer |
Instances
newRegisterStreamConsumerResponse Source #
Arguments
| :: Int | |
| -> Consumer | |
| -> RegisterStreamConsumerResponse |
Create a value of RegisterStreamConsumerResponse 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:httpStatus:RegisterStreamConsumerResponse', registerStreamConsumerResponse_httpStatus - The response's http status code.
$sel:consumer:RegisterStreamConsumerResponse', registerStreamConsumerResponse_consumer - 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
data RemoveTagsFromStream Source #
Represents the input for RemoveTagsFromStream.
See: newRemoveTagsFromStream smart constructor.
Instances
newRemoveTagsFromStream Source #
Create a value of RemoveTagsFromStream 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:
RemoveTagsFromStream, removeTagsFromStream_streamARN - The ARN of the stream.
RemoveTagsFromStream, removeTagsFromStream_streamName - The name of the stream.
$sel:tagKeys:RemoveTagsFromStream', removeTagsFromStream_tagKeys - A list of tag keys. Each corresponding tag is removed from the stream.
data RemoveTagsFromStreamResponse Source #
See: newRemoveTagsFromStreamResponse smart constructor.
Constructors
| RemoveTagsFromStreamResponse' | |
Instances
| Generic RemoveTagsFromStreamResponse Source # | |
Defined in Amazonka.Kinesis.RemoveTagsFromStream Associated Types type Rep RemoveTagsFromStreamResponse :: Type -> Type # | |
| Read RemoveTagsFromStreamResponse Source # | |
| Show RemoveTagsFromStreamResponse Source # | |
Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods showsPrec :: Int -> RemoveTagsFromStreamResponse -> ShowS # show :: RemoveTagsFromStreamResponse -> String # showList :: [RemoveTagsFromStreamResponse] -> ShowS # | |
| NFData RemoveTagsFromStreamResponse Source # | |
Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods rnf :: RemoveTagsFromStreamResponse -> () # | |
| Eq RemoveTagsFromStreamResponse Source # | |
Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods (==) :: RemoveTagsFromStreamResponse -> RemoveTagsFromStreamResponse -> Bool # (/=) :: RemoveTagsFromStreamResponse -> RemoveTagsFromStreamResponse -> Bool # | |
| type Rep RemoveTagsFromStreamResponse Source # | |
Defined in Amazonka.Kinesis.RemoveTagsFromStream | |
newRemoveTagsFromStreamResponse :: RemoveTagsFromStreamResponse Source #
Create a value of RemoveTagsFromStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SplitShard
data SplitShard Source #
Represents the input for SplitShard.
See: newSplitShard smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> SplitShard |
Create a value of SplitShard 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:
SplitShard, splitShard_streamARN - The ARN of the stream.
SplitShard, splitShard_streamName - The name of the stream for the shard split.
$sel:shardToSplit:SplitShard', splitShard_shardToSplit - The shard ID of the shard to split.
$sel:newStartingHashKey':SplitShard', splitShard_newStartingHashKey - 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.
data SplitShardResponse Source #
See: newSplitShardResponse smart constructor.
Constructors
| SplitShardResponse' | |
Instances
| Generic SplitShardResponse Source # | |
Defined in Amazonka.Kinesis.SplitShard Associated Types type Rep SplitShardResponse :: Type -> Type # Methods from :: SplitShardResponse -> Rep SplitShardResponse x # to :: Rep SplitShardResponse x -> SplitShardResponse # | |
| Read SplitShardResponse Source # | |
Defined in Amazonka.Kinesis.SplitShard Methods readsPrec :: Int -> ReadS SplitShardResponse # readList :: ReadS [SplitShardResponse] # | |
| Show SplitShardResponse Source # | |
Defined in Amazonka.Kinesis.SplitShard Methods showsPrec :: Int -> SplitShardResponse -> ShowS # show :: SplitShardResponse -> String # showList :: [SplitShardResponse] -> ShowS # | |
| NFData SplitShardResponse Source # | |
Defined in Amazonka.Kinesis.SplitShard Methods rnf :: SplitShardResponse -> () # | |
| Eq SplitShardResponse Source # | |
Defined in Amazonka.Kinesis.SplitShard Methods (==) :: SplitShardResponse -> SplitShardResponse -> Bool # (/=) :: SplitShardResponse -> SplitShardResponse -> Bool # | |
| type Rep SplitShardResponse Source # | |
newSplitShardResponse :: SplitShardResponse Source #
Create a value of SplitShardResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartStreamEncryption
data StartStreamEncryption Source #
See: newStartStreamEncryption smart constructor.
Constructors
| StartStreamEncryption' (Maybe Text) (Maybe Text) EncryptionType Text |
Instances
newStartStreamEncryption Source #
Create a value of StartStreamEncryption 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:
StartStreamEncryption, startStreamEncryption_streamARN - The ARN of the stream.
StartStreamEncryption, startStreamEncryption_streamName - The name of the stream for which to start encrypting records.
StartStreamEncryption, startStreamEncryption_encryptionType - The encryption type to use. The only valid value is KMS.
StartStreamEncryption, startStreamEncryption_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 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
data StartStreamEncryptionResponse Source #
See: newStartStreamEncryptionResponse smart constructor.
Constructors
| StartStreamEncryptionResponse' | |
Instances
| Generic StartStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StartStreamEncryption Associated Types type Rep StartStreamEncryptionResponse :: Type -> Type # | |
| Read StartStreamEncryptionResponse Source # | |
| Show StartStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StartStreamEncryption Methods showsPrec :: Int -> StartStreamEncryptionResponse -> ShowS # show :: StartStreamEncryptionResponse -> String # showList :: [StartStreamEncryptionResponse] -> ShowS # | |
| NFData StartStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StartStreamEncryption Methods rnf :: StartStreamEncryptionResponse -> () # | |
| Eq StartStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StartStreamEncryption | |
| type Rep StartStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StartStreamEncryption | |
newStartStreamEncryptionResponse :: StartStreamEncryptionResponse Source #
Create a value of StartStreamEncryptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopStreamEncryption
data StopStreamEncryption Source #
See: newStopStreamEncryption smart constructor.
Constructors
| StopStreamEncryption' (Maybe Text) (Maybe Text) EncryptionType Text |
Instances
newStopStreamEncryption Source #
Create a value of StopStreamEncryption 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:
StopStreamEncryption, stopStreamEncryption_streamARN - The ARN of the stream.
StopStreamEncryption, stopStreamEncryption_streamName - The name of the stream on which to stop encrypting records.
StopStreamEncryption, stopStreamEncryption_encryptionType - The encryption type. The only valid value is KMS.
StopStreamEncryption, stopStreamEncryption_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 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
data StopStreamEncryptionResponse Source #
See: newStopStreamEncryptionResponse smart constructor.
Constructors
| StopStreamEncryptionResponse' | |
Instances
| Generic StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Associated Types type Rep StopStreamEncryptionResponse :: Type -> Type # | |
| Read StopStreamEncryptionResponse Source # | |
| Show StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Methods showsPrec :: Int -> StopStreamEncryptionResponse -> ShowS # show :: StopStreamEncryptionResponse -> String # showList :: [StopStreamEncryptionResponse] -> ShowS # | |
| NFData StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Methods rnf :: StopStreamEncryptionResponse -> () # | |
| Eq StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Methods (==) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool # (/=) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool # | |
| type Rep StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption | |
newStopStreamEncryptionResponse :: StopStreamEncryptionResponse Source #
Create a value of StopStreamEncryptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SubscribeToShard
data SubscribeToShard Source #
See: newSubscribeToShard smart constructor.
Constructors
| SubscribeToShard' Text Text StartingPosition |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StartingPosition | |
| -> SubscribeToShard |
Create a value of SubscribeToShard 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:
SubscribeToShard, subscribeToShard_consumerARN - For this parameter, use the value you obtained when you called
RegisterStreamConsumer.
SubscribeToShard, subscribeToShard_shardId - The ID of the shard you want to subscribe to. To see a list of all the
shards for a given stream, use ListShards.
$sel:startingPosition:SubscribeToShard', subscribeToShard_startingPosition - The starting position in the data stream from which to start streaming.
data SubscribeToShardResponse Source #
See: newSubscribeToShardResponse smart constructor.
Constructors
| SubscribeToShardResponse' Int Value |
Instances
| Generic SubscribeToShardResponse Source # | |
Defined in Amazonka.Kinesis.SubscribeToShard Associated Types type Rep SubscribeToShardResponse :: Type -> Type # Methods from :: SubscribeToShardResponse -> Rep SubscribeToShardResponse x # to :: Rep SubscribeToShardResponse x -> SubscribeToShardResponse # | |
| NFData SubscribeToShardResponse Source # | |
Defined in Amazonka.Kinesis.SubscribeToShard Methods rnf :: SubscribeToShardResponse -> () # | |
| type Rep SubscribeToShardResponse Source # | |
Defined in Amazonka.Kinesis.SubscribeToShard type Rep SubscribeToShardResponse = D1 ('MetaData "SubscribeToShardResponse" "Amazonka.Kinesis.SubscribeToShard" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "SubscribeToShardResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "eventStream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value))) | |
newSubscribeToShardResponse Source #
Arguments
| :: Int | |
| -> Value | |
| -> SubscribeToShardResponse |
Create a value of SubscribeToShardResponse 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:httpStatus:SubscribeToShardResponse', subscribeToShardResponse_httpStatus - The response's http status code.
$sel:eventStream:SubscribeToShardResponse', subscribeToShardResponse_eventStream - The event stream that your consumer can use to read records from the
shard.
UpdateShardCount
data UpdateShardCount Source #
See: newUpdateShardCount smart constructor.
Constructors
| UpdateShardCount' (Maybe Text) (Maybe Text) Natural ScalingType |
Instances
Arguments
| :: Natural | |
| -> ScalingType | |
| -> UpdateShardCount |
Create a value of UpdateShardCount 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:
UpdateShardCount, updateShardCount_streamARN - The ARN of the stream.
UpdateShardCount, updateShardCount_streamName - The name of the stream.
UpdateShardCount, updateShardCount_targetShardCount - 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.
$sel:scalingType:UpdateShardCount', updateShardCount_scalingType - The scaling type. Uniform scaling creates shards of equal size.
data UpdateShardCountResponse Source #
See: newUpdateShardCountResponse smart constructor.
Instances
newUpdateShardCountResponse Source #
Create a value of UpdateShardCountResponse 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:currentShardCount:UpdateShardCountResponse', updateShardCountResponse_currentShardCount - The current number of shards.
UpdateShardCount, updateShardCountResponse_streamARN - The ARN of the stream.
UpdateShardCount, updateShardCountResponse_streamName - The name of the stream.
UpdateShardCount, updateShardCountResponse_targetShardCount - The updated number of shards.
$sel:httpStatus:UpdateShardCountResponse', updateShardCountResponse_httpStatus - The response's http status code.
UpdateStreamMode
data UpdateStreamMode Source #
See: newUpdateStreamMode smart constructor.
Constructors
| UpdateStreamMode' Text StreamModeDetails |
Instances
Arguments
| :: Text | |
| -> StreamModeDetails | |
| -> UpdateStreamMode |
Create a value of UpdateStreamMode 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:
UpdateStreamMode, updateStreamMode_streamARN - Specifies the ARN of the data stream whose capacity mode you want to
update.
UpdateStreamMode, updateStreamMode_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.
data UpdateStreamModeResponse Source #
See: newUpdateStreamModeResponse smart constructor.
Constructors
| UpdateStreamModeResponse' | |
Instances
newUpdateStreamModeResponse :: UpdateStreamModeResponse Source #
Create a value of UpdateStreamModeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
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' Text [Text] HashKeyRange |
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.
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' Text Text ConsumerStatus POSIX |
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 -
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' Text Text ConsumerStatus POSIX Text |
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.
EnhancedMetrics
data EnhancedMetrics Source #
Represents enhanced metrics types.
See: newEnhancedMetrics smart constructor.
Constructors
| EnhancedMetrics' (Maybe [MetricsName]) |
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.
EnhancedMonitoringOutput
data EnhancedMonitoringOutput Source #
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
See: newEnhancedMonitoringOutput smart constructor.
Constructors
| EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text) (Maybe Text) |
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.
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' Text Text |
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.
PutRecordsRequestEntry
data PutRecordsRequestEntry Source #
Represents the output for PutRecords.
See: newPutRecordsRequestEntry smart constructor.
Constructors
| PutRecordsRequestEntry' (Maybe Text) Base64 Text |
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.
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.
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.
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.
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.
SequenceNumberRange
data SequenceNumberRange Source #
The range of possible sequence numbers for the shard.
See: newSequenceNumberRange smart constructor.
Constructors
| SequenceNumberRange' (Maybe Text) Text |
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.
Shard
A uniquely identified group of data records in a Kinesis data stream.
See: newShard smart constructor.
Constructors
| Shard' (Maybe Text) (Maybe Text) Text HashKeyRange SequenceNumberRange |
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.
ShardFilter
data ShardFilter Source #
The request parameter used to filter out the response of the
ListShards API.
See: newShardFilter smart constructor.
Constructors
| ShardFilter' (Maybe Text) (Maybe POSIX) ShardFilterType |
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.
StartingPosition
data StartingPosition Source #
The starting position in the data stream from which to start streaming.
See: newStartingPosition smart constructor.
Constructors
| StartingPosition' (Maybe Text) (Maybe POSIX) ShardIteratorType |
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.
StreamDescription
data StreamDescription Source #
Represents the output for DescribeStream.
See: newStreamDescription smart constructor.
Constructors
| StreamDescription' (Maybe EncryptionType) (Maybe Text) (Maybe StreamModeDetails) Text Text StreamStatus [Shard] Bool Int POSIX [EnhancedMetrics] |
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.
StreamDescriptionSummary
data StreamDescriptionSummary Source #
Represents the output for DescribeStreamSummary
See: newStreamDescriptionSummary smart constructor.
Constructors
| StreamDescriptionSummary' (Maybe Natural) (Maybe EncryptionType) (Maybe Text) (Maybe StreamModeDetails) Text Text StreamStatus Int POSIX [EnhancedMetrics] Natural |
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.
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' StreamMode |
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.
StreamSummary
data StreamSummary Source #
The summary of a stream.
See: newStreamSummary smart constructor.
Constructors
| StreamSummary' (Maybe POSIX) (Maybe StreamModeDetails) Text Text StreamStatus |
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.
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' (Maybe [ChildShard]) [Record] Text Natural |
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.
Tag
Metadata assigned to the stream, consisting of a key-value pair.
See: newTag smart constructor.
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, _ . / = + - % @