| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Kinesis
Contents
- Service Configuration
- Errors
- KMSInvalidStateException
- KMSThrottlingException
- ExpiredIteratorException
- InvalidArgumentException
- KMSOptInRequired
- ProvisionedThroughputExceededException
- KMSNotFoundException
- ExpiredNextTokenException
- KMSDisabledException
- ResourceNotFoundException
- KMSAccessDeniedException
- LimitExceededException
- ResourceInUseException
- Waiters
- Operations
- PutRecord
- DecreaseStreamRetentionPeriod
- MergeShards
- DescribeStreamSummary
- GetShardIterator
- GetRecords
- StopStreamEncryption
- EnableEnhancedMonitoring
- DescribeLimits
- DisableEnhancedMonitoring
- UpdateShardCount
- ListTagsForStream
- AddTagsToStream
- PutRecords
- ListShards
- DeleteStream
- RemoveTagsFromStream
- ListStreams (Paginated)
- CreateStream
- StartStreamEncryption
- SplitShard
- IncreaseStreamRetentionPeriod
- DescribeStream (Paginated)
- Types
Description
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
- kinesis :: Service
- _KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _ExpiredIteratorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSOptInRequired :: AsError a => Getting (First ServiceError) a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- streamExists :: Wait DescribeStream
- streamNotExists :: Wait DescribeStream
- module Network.AWS.Kinesis.PutRecord
- module Network.AWS.Kinesis.DecreaseStreamRetentionPeriod
- module Network.AWS.Kinesis.MergeShards
- module Network.AWS.Kinesis.DescribeStreamSummary
- module Network.AWS.Kinesis.GetShardIterator
- module Network.AWS.Kinesis.GetRecords
- module Network.AWS.Kinesis.StopStreamEncryption
- module Network.AWS.Kinesis.EnableEnhancedMonitoring
- module Network.AWS.Kinesis.DescribeLimits
- module Network.AWS.Kinesis.DisableEnhancedMonitoring
- module Network.AWS.Kinesis.UpdateShardCount
- module Network.AWS.Kinesis.ListTagsForStream
- module Network.AWS.Kinesis.AddTagsToStream
- module Network.AWS.Kinesis.PutRecords
- module Network.AWS.Kinesis.ListShards
- module Network.AWS.Kinesis.DeleteStream
- module Network.AWS.Kinesis.RemoveTagsFromStream
- module Network.AWS.Kinesis.ListStreams
- module Network.AWS.Kinesis.CreateStream
- module Network.AWS.Kinesis.StartStreamEncryption
- module Network.AWS.Kinesis.SplitShard
- module Network.AWS.Kinesis.IncreaseStreamRetentionPeriod
- module Network.AWS.Kinesis.DescribeStream
- data EncryptionType
- data MetricsName
- data ScalingType = UniformScaling
- data ShardIteratorType
- data StreamStatus
- data EnhancedMetrics
- enhancedMetrics :: EnhancedMetrics
- emShardLevelMetrics :: Lens' EnhancedMetrics [MetricsName]
- data EnhancedMonitoringOutput
- enhancedMonitoringOutput :: EnhancedMonitoringOutput
- emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]
- emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]
- emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text)
- data HashKeyRange
- hashKeyRange :: Text -> Text -> HashKeyRange
- hkrStartingHashKey :: Lens' HashKeyRange Text
- hkrEndingHashKey :: Lens' HashKeyRange Text
- data PutRecordsRequestEntry
- putRecordsRequestEntry :: ByteString -> Text -> PutRecordsRequestEntry
- prreExplicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)
- prreData :: Lens' PutRecordsRequestEntry ByteString
- prrePartitionKey :: Lens' PutRecordsRequestEntry Text
- data PutRecordsResultEntry
- putRecordsResultEntry :: PutRecordsResultEntry
- prreSequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text)
- prreErrorCode :: Lens' PutRecordsResultEntry (Maybe Text)
- prreErrorMessage :: Lens' PutRecordsResultEntry (Maybe Text)
- prreShardId :: Lens' PutRecordsResultEntry (Maybe Text)
- data Record
- record :: Text -> ByteString -> Text -> Record
- rEncryptionType :: Lens' Record (Maybe EncryptionType)
- rApproximateArrivalTimestamp :: Lens' Record (Maybe UTCTime)
- rSequenceNumber :: Lens' Record Text
- rData :: Lens' Record ByteString
- rPartitionKey :: Lens' Record Text
- data SequenceNumberRange
- sequenceNumberRange :: Text -> SequenceNumberRange
- snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)
- snrStartingSequenceNumber :: Lens' SequenceNumberRange Text
- data Shard
- shard :: Text -> HashKeyRange -> SequenceNumberRange -> Shard
- sAdjacentParentShardId :: Lens' Shard (Maybe Text)
- sParentShardId :: Lens' Shard (Maybe Text)
- sShardId :: Lens' Shard Text
- sHashKeyRange :: Lens' Shard HashKeyRange
- sSequenceNumberRange :: Lens' Shard SequenceNumberRange
- data StreamDescription
- streamDescription :: Text -> Text -> StreamStatus -> Bool -> Natural -> UTCTime -> StreamDescription
- sdEncryptionType :: Lens' StreamDescription (Maybe EncryptionType)
- sdKeyId :: Lens' StreamDescription (Maybe Text)
- sdStreamName :: Lens' StreamDescription Text
- sdStreamARN :: Lens' StreamDescription Text
- sdStreamStatus :: Lens' StreamDescription StreamStatus
- sdShards :: Lens' StreamDescription [Shard]
- sdHasMoreShards :: Lens' StreamDescription Bool
- sdRetentionPeriodHours :: Lens' StreamDescription Natural
- sdStreamCreationTimestamp :: Lens' StreamDescription UTCTime
- sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics]
- data StreamDescriptionSummary
- streamDescriptionSummary :: Text -> Text -> StreamStatus -> Natural -> UTCTime -> Natural -> StreamDescriptionSummary
- sdsEncryptionType :: Lens' StreamDescriptionSummary (Maybe EncryptionType)
- sdsKeyId :: Lens' StreamDescriptionSummary (Maybe Text)
- sdsStreamName :: Lens' StreamDescriptionSummary Text
- sdsStreamARN :: Lens' StreamDescriptionSummary Text
- sdsStreamStatus :: Lens' StreamDescriptionSummary StreamStatus
- sdsRetentionPeriodHours :: Lens' StreamDescriptionSummary Natural
- sdsStreamCreationTimestamp :: Lens' StreamDescriptionSummary UTCTime
- sdsEnhancedMonitoring :: Lens' StreamDescriptionSummary [EnhancedMetrics]
- sdsOpenShardCount :: Lens' StreamDescriptionSummary Natural
- data Tag
- tag :: Text -> Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag Text
Service 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.
KMSInvalidStateException
_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError #
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 AWS Key Management Service Developer Guide .
KMSThrottlingException
_KMSThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError #
The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide .
ExpiredIteratorException
_ExpiredIteratorException :: AsError a => Getting (First ServiceError) a ServiceError #
The provided iterator exceeds the maximum age allowed.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError #
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
KMSOptInRequired
_KMSOptInRequired :: AsError a => Getting (First ServiceError) a ServiceError #
The AWS access key ID needs a subscription for the service.
ProvisionedThroughputExceededException
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
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 AWS in the AWS General Reference .
KMSNotFoundException
_KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The request was rejected because the specified entity or resource can't be found.
ExpiredNextTokenException
_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError #
The pagination token passed to the ListShards operation is expired. For more information, see 'ListShardsInput$NextToken' .
KMSDisabledException
_KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError #
The request was rejected because the specified customer master key (CMK) isn't enabled.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The requested resource could not be found. The stream might not be specified correctly.
KMSAccessDeniedException
_KMSAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError #
The ciphertext references a key that doesn't exist or that you don't have access to.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError #
The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.
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
streamExists :: Wait DescribeStream #
Polls DescribeStream every 10 seconds until a successful state is reached. An error is returned after 18 failed checks.
StreamNotExists
streamNotExists :: Wait DescribeStream #
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.
PutRecord
DecreaseStreamRetentionPeriod
MergeShards
DescribeStreamSummary
GetShardIterator
GetRecords
StopStreamEncryption
EnableEnhancedMonitoring
DescribeLimits
DisableEnhancedMonitoring
UpdateShardCount
ListTagsForStream
AddTagsToStream
PutRecords
ListShards
DeleteStream
RemoveTagsFromStream
ListStreams (Paginated)
CreateStream
StartStreamEncryption
SplitShard
IncreaseStreamRetentionPeriod
DescribeStream (Paginated)
Types
EncryptionType
data EncryptionType #
Instances
MetricsName
data MetricsName #
Constructors
| All | |
| IncomingBytes | |
| IncomingRecords | |
| IteratorAgeMilliseconds | |
| OutgoingBytes | |
| OutgoingRecords | |
| ReadProvisionedThroughputExceeded | |
| WriteProvisionedThroughputExceeded |
Instances
ScalingType
data ScalingType #
Constructors
| UniformScaling |
Instances
ShardIteratorType
data ShardIteratorType #
Constructors
| AfterSequenceNumber | |
| AtSequenceNumber | |
| AtTimestamp | |
| Latest | |
| TrimHorizon |
Instances
StreamStatus
data StreamStatus #
Instances
EnhancedMetrics
data EnhancedMetrics #
Represents enhanced metrics types.
See: enhancedMetrics smart constructor.
Instances
enhancedMetrics :: EnhancedMetrics #
Creates a value of EnhancedMetrics with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
emShardLevelMetrics- 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*ALLFor more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide .
emShardLevelMetrics :: Lens' EnhancedMetrics [MetricsName] #
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 #
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring .
See: enhancedMonitoringOutput smart constructor.
Instances
enhancedMonitoringOutput :: EnhancedMonitoringOutput #
Creates a value of EnhancedMonitoringOutput with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
emoDesiredShardLevelMetrics- Represents the list of all the metrics that would be in the enhanced state after the operation.emoCurrentShardLevelMetrics- Represents the current state of the metrics that are in the enhanced state before the operation.emoStreamName- The name of the Kinesis data stream.
emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName] #
Represents the list of all the metrics that would be in the enhanced state after the operation.
emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName] #
Represents the current state of the metrics that are in the enhanced state before the operation.
emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text) #
The name of the Kinesis data stream.
HashKeyRange
data HashKeyRange #
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
See: hashKeyRange smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> HashKeyRange |
Creates a value of HashKeyRange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hkrStartingHashKey- The starting hash key of the hash key range.hkrEndingHashKey- The ending hash key of the hash key range.
hkrStartingHashKey :: Lens' HashKeyRange Text #
The starting hash key of the hash key range.
hkrEndingHashKey :: Lens' HashKeyRange Text #
The ending hash key of the hash key range.
PutRecordsRequestEntry
data PutRecordsRequestEntry #
Represents the output for PutRecords .
See: putRecordsRequestEntry smart constructor.
Instances
Arguments
| :: ByteString | |
| -> Text | |
| -> PutRecordsRequestEntry |
Creates a value of PutRecordsRequestEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prreExplicitHashKey- The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.prreData- 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 MB).-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.prrePartitionKey- 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.
prreExplicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text) #
The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
prreData :: Lens' PutRecordsRequestEntry ByteString #
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 MB).-- 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.
prrePartitionKey :: Lens' PutRecordsRequestEntry Text #
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 #
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: putRecordsResultEntry smart constructor.
Instances
putRecordsResultEntry :: PutRecordsResultEntry #
Creates a value of PutRecordsResultEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prreSequenceNumber- The sequence number for an individual record result.prreErrorCode- The error code for an individual record result.ErrorCodescan be eitherProvisionedThroughputExceededExceptionorInternalFailure.prreErrorMessage- The error message for an individual record result. AnErrorCodevalue ofProvisionedThroughputExceededExceptionhas an error message that includes the account ID, stream name, and shard ID. AnErrorCodevalue ofInternalFailurehas the error message"Internal Service Failure".prreShardId- The shard ID for an individual record result.
prreSequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text) #
The sequence number for an individual record result.
prreErrorCode :: Lens' PutRecordsResultEntry (Maybe Text) #
The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure .
prreErrorMessage :: Lens' PutRecordsResultEntry (Maybe Text) #
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" .
prreShardId :: Lens' PutRecordsResultEntry (Maybe Text) #
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: record smart constructor.
Instances
| Eq Record # | |
| Data Record # | |
Defined in Network.AWS.Kinesis.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Record -> c Record # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Record # toConstr :: Record -> Constr # dataTypeOf :: Record -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Record) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Record) # gmapT :: (forall b. Data b => b -> b) -> Record -> Record # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Record -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Record -> r # gmapQ :: (forall d. Data d => d -> u) -> Record -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Record -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Record -> m Record # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Record -> m Record # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Record -> m Record # | |
| Read Record # | |
| Show Record # | |
| Generic Record # | |
| Hashable Record # | |
Defined in Network.AWS.Kinesis.Types.Product | |
| FromJSON Record # | |
| NFData Record # | |
Defined in Network.AWS.Kinesis.Types.Product | |
| type Rep Record # | |
Defined in Network.AWS.Kinesis.Types.Product type Rep Record = D1 (MetaData "Record" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-4YDemIxP4OfE57cYVD0y1c" False) (C1 (MetaCons "Record'" PrefixI True) ((S1 (MetaSel (Just "_rEncryptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncryptionType)) :*: S1 (MetaSel (Just "_rApproximateArrivalTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 (MetaSel (Just "_rSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_rData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Base64) :*: S1 (MetaSel (Just "_rPartitionKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))) | |
Arguments
| :: Text | |
| -> ByteString | |
| -> Text | |
| -> Record |
Creates a value of Record with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rEncryptionType- 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 AWS KMS key.rApproximateArrivalTimestamp- The approximate time that the record was inserted into the stream.rSequenceNumber- The unique identifier of the record within its shard.rData- 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 MB).-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.rPartitionKey- Identifies which shard in the stream the data record is assigned to.
rEncryptionType :: Lens' Record (Maybe 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 AWS KMS key.
rApproximateArrivalTimestamp :: Lens' Record (Maybe UTCTime) #
The approximate time that the record was inserted into the stream.
rSequenceNumber :: Lens' Record Text #
The unique identifier of the record within its shard.
rData :: Lens' Record ByteString #
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 MB).-- 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.
rPartitionKey :: Lens' Record Text #
Identifies which shard in the stream the data record is assigned to.
SequenceNumberRange
data SequenceNumberRange #
The range of possible sequence numbers for the shard.
See: sequenceNumberRange smart constructor.
Instances
Arguments
| :: Text | |
| -> SequenceNumberRange |
Creates a value of SequenceNumberRange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
snrEndingSequenceNumber- The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number ofnull.snrStartingSequenceNumber- The starting sequence number for the range.
snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text) #
The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null .
snrStartingSequenceNumber :: Lens' SequenceNumberRange Text #
The starting sequence number for the range.
Shard
A uniquely identified group of data records in a Kinesis data stream.
See: shard smart constructor.
Instances
| Eq Shard # | |
| Data Shard # | |
Defined in Network.AWS.Kinesis.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Shard -> c Shard # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Shard # dataTypeOf :: Shard -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Shard) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Shard) # gmapT :: (forall b. Data b => b -> b) -> Shard -> Shard # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Shard -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Shard -> r # gmapQ :: (forall d. Data d => d -> u) -> Shard -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Shard -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Shard -> m Shard # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Shard -> m Shard # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Shard -> m Shard # | |
| Read Shard # | |
| Show Shard # | |
| Generic Shard # | |
| Hashable Shard # | |
Defined in Network.AWS.Kinesis.Types.Product | |
| FromJSON Shard # | |
| NFData Shard # | |
Defined in Network.AWS.Kinesis.Types.Product | |
| type Rep Shard # | |
Defined in Network.AWS.Kinesis.Types.Product type Rep Shard = D1 (MetaData "Shard" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-4YDemIxP4OfE57cYVD0y1c" False) (C1 (MetaCons "Shard'" PrefixI True) ((S1 (MetaSel (Just "_sAdjacentParentShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sParentShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_sHashKeyRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HashKeyRange) :*: S1 (MetaSel (Just "_sSequenceNumberRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SequenceNumberRange))))) | |
Arguments
| :: Text | |
| -> HashKeyRange | |
| -> SequenceNumberRange | |
| -> Shard |
Creates a value of Shard with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sAdjacentParentShardId- The shard ID of the shard adjacent to the shard's parent.sParentShardId- The shard ID of the shard's parent.sShardId- The unique identifier of the shard within the stream.sHashKeyRange- The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.sSequenceNumberRange- The range of possible sequence numbers for the shard.
sAdjacentParentShardId :: Lens' Shard (Maybe Text) #
The shard ID of the shard adjacent to the shard's parent.
sHashKeyRange :: Lens' Shard HashKeyRange #
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
sSequenceNumberRange :: Lens' Shard SequenceNumberRange #
The range of possible sequence numbers for the shard.
StreamDescription
data StreamDescription #
Represents the output for DescribeStream .
See: streamDescription smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StreamStatus | |
| -> Bool | |
| -> Natural | |
| -> UTCTime | |
| -> StreamDescription |
Creates a value of StreamDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdEncryptionType- 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 AWS KMS key.sdKeyId- The GUID for the customer-managed AWS 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 @awskinesis. * Key ARN example:arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012* Alias ARN example:arn:aws:kms:us-east-1:123456789012:aliasMyAliasName* Globally unique key ID example:12345678-1234-1234-1234-123456789012* Alias name example:aliasMyAliasName* Master key owned by Kinesis Data Streams:aliasaws/kinesis@sdStreamName- The name of the stream being described.sdStreamARN- The Amazon Resource Name (ARN) for the stream being described.sdStreamStatus- 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.sdShards- The shards that comprise the stream.sdHasMoreShards- If set totrue, more shards in the stream are available to describe.sdRetentionPeriodHours- The current retention period, in hours.sdStreamCreationTimestamp- The approximate time that the stream was created.sdEnhancedMonitoring- Represents the current enhanced monitoring settings of the stream.
sdEncryptionType :: Lens' StreamDescription (Maybe 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 AWS KMS key.
sdKeyId :: Lens' StreamDescription (Maybe Text) #
The GUID for the customer-managed AWS 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 @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@
sdStreamName :: Lens' StreamDescription Text #
The name of the stream being described.
sdStreamARN :: Lens' StreamDescription Text #
The Amazon Resource Name (ARN) for the stream being described.
sdStreamStatus :: Lens' 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 sets StreamStatus to CREATING . * DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. * ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream. * UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
sdShards :: Lens' StreamDescription [Shard] #
The shards that comprise the stream.
sdHasMoreShards :: Lens' StreamDescription Bool #
If set to true , more shards in the stream are available to describe.
sdRetentionPeriodHours :: Lens' StreamDescription Natural #
The current retention period, in hours.
sdStreamCreationTimestamp :: Lens' StreamDescription UTCTime #
The approximate time that the stream was created.
sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics] #
Represents the current enhanced monitoring settings of the stream.
StreamDescriptionSummary
data StreamDescriptionSummary #
Represents the output for DescribeStreamSummary
See: streamDescriptionSummary smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StreamStatus | |
| -> Natural | |
| -> UTCTime | |
| -> Natural | |
| -> StreamDescriptionSummary |
Creates a value of StreamDescriptionSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdsEncryptionType- The encryption type used. This value is one of the following: *KMS*NONEsdsKeyId- The GUID for the customer-managed AWS 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 @awskinesis. * Key ARN example:arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012* Alias ARN example:arn:aws:kms:us-east-1:123456789012:aliasMyAliasName* Globally unique key ID example:12345678-1234-1234-1234-123456789012* Alias name example:aliasMyAliasName* Master key owned by Kinesis Data Streams:aliasaws/kinesis@sdsStreamName- The name of the stream being described.sdsStreamARN- The Amazon Resource Name (ARN) for the stream being described.sdsStreamStatus- 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.sdsRetentionPeriodHours- The current retention period, in hours.sdsStreamCreationTimestamp- The approximate time that the stream was created.sdsEnhancedMonitoring- Represents the current enhanced monitoring settings of the stream.sdsOpenShardCount- The number of open shards in the stream.
sdsEncryptionType :: Lens' StreamDescriptionSummary (Maybe EncryptionType) #
The encryption type used. This value is one of the following: * KMS * NONE
sdsKeyId :: Lens' StreamDescriptionSummary (Maybe Text) #
The GUID for the customer-managed AWS 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 @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@
sdsStreamName :: Lens' StreamDescriptionSummary Text #
The name of the stream being described.
sdsStreamARN :: Lens' StreamDescriptionSummary Text #
The Amazon Resource Name (ARN) for the stream being described.
sdsStreamStatus :: Lens' 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 sets StreamStatus to CREATING . * DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. * ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream. * UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
sdsRetentionPeriodHours :: Lens' StreamDescriptionSummary Natural #
The current retention period, in hours.
sdsStreamCreationTimestamp :: Lens' StreamDescriptionSummary UTCTime #
The approximate time that the stream was created.
sdsEnhancedMonitoring :: Lens' StreamDescriptionSummary [EnhancedMetrics] #
Represents the current enhanced monitoring settings of the stream.
sdsOpenShardCount :: Lens' StreamDescriptionSummary Natural #
The number of open shards in the stream.
Tag
Metadata assigned to the stream, consisting of a key-value pair.
See: tag smart constructor.
Instances
| Eq Tag # | |
| Data Tag # | |
Defined in Network.AWS.Kinesis.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # dataTypeOf :: Tag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Tag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) # gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # | |
| Read Tag # | |
| Show Tag # | |
| Generic Tag # | |
| Hashable Tag # | |
Defined in Network.AWS.Kinesis.Types.Product | |
| FromJSON Tag # | |
| NFData Tag # | |
Defined in Network.AWS.Kinesis.Types.Product | |
| type Rep Tag # | |
Defined in Network.AWS.Kinesis.Types.Product type Rep Tag = D1 (MetaData "Tag" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-4YDemIxP4OfE57cYVD0y1c" False) (C1 (MetaCons "Tag'" PrefixI True) (S1 (MetaSel (Just "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) | |
Creates a value of Tag with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tagValue- An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @tagKey- A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @