| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Kinesis.Types
Contents
Description
- kinesis :: Service
- _ExpiredIteratorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data MetricsName
- data ShardIteratorType
- data StreamStatus
- data EnhancedMetrics
- enhancedMetrics :: EnhancedMetrics
- emShardLevelMetrics :: Lens' EnhancedMetrics (Maybe (NonEmpty MetricsName))
- data EnhancedMonitoringOutput
- enhancedMonitoringOutput :: EnhancedMonitoringOutput
- emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe (NonEmpty MetricsName))
- emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe (NonEmpty 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
- 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 -> StreamDescription
- sdStreamName :: Lens' StreamDescription Text
- sdStreamARN :: Lens' StreamDescription Text
- sdStreamStatus :: Lens' StreamDescription StreamStatus
- sdShards :: Lens' StreamDescription [Shard]
- sdHasMoreShards :: Lens' StreamDescription Bool
- sdRetentionPeriodHours :: Lens' StreamDescription Natural
- sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics]
- data Tag
- tag :: Text -> Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag Text
Service Configuration
Errors
_ExpiredIteratorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The provided iterator exceeds the maximum age allowed.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) 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 Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource could not be found. The stream might not be
specified correctly, or it might not be in the ACTIVE state if the
operation requires it.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is not available for this operation. For successful
operation, the resource needs to be in the ACTIVE state.
MetricsName
data MetricsName Source #
Constructors
| All | |
| IncomingBytes | |
| IncomingRecords | |
| IteratorAgeMilliseconds | |
| OutgoingBytes | |
| OutgoingRecords | |
| ReadProvisionedThroughputExceeded | |
| WriteProvisionedThroughputExceeded |
Instances
ShardIteratorType
data ShardIteratorType Source #
Constructors
| AfterSequenceNumber | |
| AtSequenceNumber | |
| AtTimestamp | |
| Latest | |
| TrimHorizon |
Instances
StreamStatus
data StreamStatus Source #
Instances
EnhancedMetrics
data EnhancedMetrics Source #
Represents enhanced metrics types.
See: enhancedMetrics smart constructor.
enhancedMetrics :: EnhancedMetrics Source #
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 :: Lens' EnhancedMetrics (Maybe (NonEmpty MetricsName)) Source #
List of shard-level metrics.
The following are the valid shard-level metrics. The value "ALL"
enhances every metric.
IncomingBytesIncomingRecordsOutgoingBytesOutgoingRecordsWriteProvisionedThroughputExceededReadProvisionedThroughputExceededIteratorAgeMillisecondsALL
For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.
EnhancedMonitoringOutput
data EnhancedMonitoringOutput Source #
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
See: enhancedMonitoringOutput smart constructor.
Instances
enhancedMonitoringOutput :: EnhancedMonitoringOutput Source #
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 :: Lens' EnhancedMonitoringOutput (Maybe (NonEmpty MetricsName)) Source #
Represents the list of all the metrics that would be in the enhanced state after the operation.
emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput (Maybe (NonEmpty MetricsName)) Source #
Represents the current state of the metrics that are in the enhanced state before the operation.
emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text) Source #
The name of the Amazon Kinesis 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: hashKeyRange smart constructor.
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 :: Lens' HashKeyRange Text Source #
The starting hash key of the hash key range.
hkrEndingHashKey :: Lens' HashKeyRange Text Source #
The ending hash key of the hash key range.
PutRecordsRequestEntry
data PutRecordsRequestEntry Source #
Represents the output for PutRecords.
See: putRecordsRequestEntry smart constructor.
Instances
putRecordsRequestEntry Source #
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 :: Lens' PutRecordsRequestEntry (Maybe Text) Source #
The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
prreData :: Lens' PutRecordsRequestEntry ByteString Source #
The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
Note: This Lens automatically encodes and decodes Base64 data,
despite what the AWS documentation might say.
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 Source #
Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis 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: putRecordsResultEntry smart constructor.
Instances
putRecordsResultEntry :: PutRecordsResultEntry Source #
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 :: Lens' PutRecordsResultEntry (Maybe Text) Source #
The sequence number for an individual record result.
prreErrorCode :: Lens' PutRecordsResultEntry (Maybe Text) Source #
The error code for an individual record result. ErrorCodes can be
either ProvisionedThroughputExceededException or InternalFailure.
prreShardId :: Lens' PutRecordsResultEntry (Maybe Text) Source #
The shard ID for an individual record result.
Record
The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.
See: record smart constructor.
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:
rApproximateArrivalTimestamp :: Lens' Record (Maybe UTCTime) Source #
The approximate time that the record was inserted into the stream.
rData :: Lens' Record ByteString Source #
The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. 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,
despite what the AWS documentation might say.
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 Source #
Identifies which shard in the stream the data record is assigned to.
SequenceNumberRange
data SequenceNumberRange Source #
The range of possible sequence numbers for the shard.
See: 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 :: Lens' SequenceNumberRange (Maybe Text) Source #
The ending sequence number for the range. Shards that are in the OPEN
state have an ending sequence number of null.
snrStartingSequenceNumber :: Lens' SequenceNumberRange Text Source #
The starting sequence number for the range.
Shard
A uniquely identified group of data records in an Amazon Kinesis stream.
See: shard smart constructor.
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 :: Lens' Shard (Maybe Text) Source #
The shard ID of the shard adjacent to the shard's parent.
sHashKeyRange :: Lens' Shard HashKeyRange Source #
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
sSequenceNumberRange :: Lens' Shard SequenceNumberRange Source #
The range of possible sequence numbers for the shard.
StreamDescription
data StreamDescription Source #
Represents the output for DescribeStream.
See: streamDescription smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StreamStatus | |
| -> Bool | |
| -> Natural | |
| -> 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:
sdStreamName :: Lens' StreamDescription Text Source #
The name of the stream being described.
sdStreamARN :: Lens' StreamDescription Text Source #
The Amazon Resource Name (ARN) for the stream being described.
sdStreamStatus :: Lens' StreamDescription StreamStatus Source #
The current status of the stream being described. The stream status is one of the following states:
CREATING- The stream is being created. Amazon Kinesis immediately returns and setsStreamStatustoCREATING.DELETING- The stream is being deleted. The specified stream is in theDELETINGstate until Amazon Kinesis completes the deletion.ACTIVE- The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on anACTIVEstream.UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
sdHasMoreShards :: Lens' StreamDescription Bool Source #
If set to true, more shards in the stream are available to describe.
sdRetentionPeriodHours :: Lens' StreamDescription Natural Source #
The current retention period, in hours.
sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics] Source #
Represents the current enhanced monitoring settings of the stream.
Tag
Metadata assigned to the stream, consisting of a key-value pair.
See: tag smart constructor.