-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Amazon Kinesis SDK.
--   
--   The types from this library are intended to be used with
--   <a>amazonka</a>, which provides mechanisms for specifying AuthN/AuthZ
--   information, sending requests, and receiving responses.
--   
--   Lenses are used for constructing and manipulating types, due to the
--   depth of nesting of AWS types and transparency regarding
--   de/serialisation into more palatable Haskell values. The provided
--   lenses should be compatible with any of the major lens libraries such
--   as <a>lens</a> or <a>lens-family-core</a>.
--   
--   See <a>Network.AWS.Kinesis</a> or <a>the AWS documentation</a> to get
--   started.
@package amazonka-kinesis
@version 1.6.0


module Network.AWS.Kinesis.Types

-- | API version <tt>2013-12-02</tt> of the Amazon Kinesis SDK
--   configuration.
kinesis :: Service

-- | The request was rejected because the state of the specified resource
--   isn't valid for this request. For more information, see <a>How Key
--   State Affects Use of a Customer Master Key</a> in the <i>AWS Key
--   Management Service Developer Guide</i> .
_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The request was denied due to request throttling. For more information
--   about throttling, see <a>Limits</a> in the <i>AWS Key Management
--   Service Developer Guide</i> .
_KMSThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The provided iterator exceeds the maximum age allowed.
_ExpiredIteratorException :: 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.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The AWS access key ID needs a subscription for the service.
_KMSOptInRequired :: 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 <a>Streams Limits</a> in
--   the <i>Amazon Kinesis Data Streams Developer Guide</i> , and <a>Error
--   Retries and Exponential Backoff in AWS</a> in the <i>AWS General
--   Reference</i> .
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The request was rejected because the specified entity or resource
--   can't be found.
_KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The pagination token passed to the <tt>ListShards</tt> operation is
--   expired. For more information, see 'ListShardsInput$NextToken' .
_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The request was rejected because the specified customer master key
--   (CMK) isn't enabled.
_KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The requested resource could not be found. The stream might not be
--   specified correctly.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The ciphertext references a key that doesn't exist or that you don't
--   have access to.
_KMSAccessDeniedException :: 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.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The resource is not available for this operation. For successful
--   operation, the resource must be in the <tt>ACTIVE</tt> state.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
data EncryptionType
KMS :: EncryptionType
None :: EncryptionType
data MetricsName
All :: MetricsName
IncomingBytes :: MetricsName
IncomingRecords :: MetricsName
IteratorAgeMilliseconds :: MetricsName
OutgoingBytes :: MetricsName
OutgoingRecords :: MetricsName
ReadProvisionedThroughputExceeded :: MetricsName
WriteProvisionedThroughputExceeded :: MetricsName
data ScalingType
UniformScaling :: ScalingType
data ShardIteratorType
AfterSequenceNumber :: ShardIteratorType
AtSequenceNumber :: ShardIteratorType
AtTimestamp :: ShardIteratorType
Latest :: ShardIteratorType
TrimHorizon :: ShardIteratorType
data StreamStatus
Active :: StreamStatus
Creating :: StreamStatus
Deleting :: StreamStatus
Updating :: StreamStatus

-- | Represents enhanced metrics types.
--   
--   <i>See:</i> <a>enhancedMetrics</a> smart constructor.
data EnhancedMetrics

-- | Creates a value of <a>EnhancedMetrics</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>emShardLevelMetrics</a> - List of shard-level metrics. The
--   following are the valid shard-level metrics. The value "<tt>ALL</tt> "
--   enhances every metric. * <tt>IncomingBytes</tt> *
--   <tt>IncomingRecords</tt> * <tt>OutgoingBytes</tt> *
--   <tt>OutgoingRecords</tt> * <tt>WriteProvisionedThroughputExceeded</tt>
--   * <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .</li>
--   </ul>
enhancedMetrics :: EnhancedMetrics

-- | List of shard-level metrics. The following are the valid shard-level
--   metrics. The value "<tt>ALL</tt> " enhances every metric. *
--   <tt>IncomingBytes</tt> * <tt>IncomingRecords</tt> *
--   <tt>OutgoingBytes</tt> * <tt>OutgoingRecords</tt> *
--   <tt>WriteProvisionedThroughputExceeded</tt> *
--   <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .
emShardLevelMetrics :: Lens' EnhancedMetrics [MetricsName]

-- | Represents the output for <tt>EnableEnhancedMonitoring</tt> and
--   <tt>DisableEnhancedMonitoring</tt> .
--   
--   <i>See:</i> <a>enhancedMonitoringOutput</a> smart constructor.
data EnhancedMonitoringOutput

-- | Creates a value of <a>EnhancedMonitoringOutput</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>emoDesiredShardLevelMetrics</a> - Represents the list of all
--   the metrics that would be in the enhanced state after the
--   operation.</li>
--   <li><a>emoCurrentShardLevelMetrics</a> - Represents the current state
--   of the metrics that are in the enhanced state before the
--   operation.</li>
--   <li><a>emoStreamName</a> - The name of the Kinesis data stream.</li>
--   </ul>
enhancedMonitoringOutput :: EnhancedMonitoringOutput

-- | Represents the list of all the metrics that would be in the enhanced
--   state after the operation.
emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | Represents the current state of the metrics that are in the enhanced
--   state before the operation.
emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | The name of the Kinesis data stream.
emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text)

-- | The range of possible hash key values for the shard, which is a set of
--   ordered contiguous positive integers.
--   
--   <i>See:</i> <a>hashKeyRange</a> smart constructor.
data HashKeyRange

-- | Creates a value of <a>HashKeyRange</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>hkrStartingHashKey</a> - The starting hash key of the hash key
--   range.</li>
--   <li><a>hkrEndingHashKey</a> - The ending hash key of the hash key
--   range.</li>
--   </ul>
hashKeyRange :: Text -> Text -> HashKeyRange

-- | The starting hash key of the hash key range.
hkrStartingHashKey :: Lens' HashKeyRange Text

-- | The ending hash key of the hash key range.
hkrEndingHashKey :: Lens' HashKeyRange Text

-- | Represents the output for <tt>PutRecords</tt> .
--   
--   <i>See:</i> <a>putRecordsRequestEntry</a> smart constructor.
data PutRecordsRequestEntry

-- | Creates a value of <a>PutRecordsRequestEntry</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>prreExplicitHashKey</a> - The hash value used to determine
--   explicitly the shard that the data record is assigned to by overriding
--   the partition key hash.</li>
--   <li><a>prreData</a> - 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).--
--   <i>Note:</i> This <tt>Lens</tt> automatically encodes and decodes
--   Base64 data. The underlying isomorphism will encode to Base64
--   representation during serialisation, and decode from Base64
--   representation during deserialisation. This <tt>Lens</tt> accepts and
--   returns only raw unencoded data.</li>
--   <li><a>prrePartitionKey</a> - 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.</li>
--   </ul>
putRecordsRequestEntry :: ByteString -> Text -> PutRecordsRequestEntry

-- | The hash value used to determine explicitly the shard that the data
--   record is assigned to by overriding the partition key hash.
prreExplicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)

-- | 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).-- <i>Note:</i> This
--   <tt>Lens</tt> automatically encodes and decodes Base64 data. The
--   underlying isomorphism will encode to Base64 representation during
--   serialisation, and decode from Base64 representation during
--   deserialisation. This <tt>Lens</tt> accepts and returns only raw
--   unencoded data.
prreData :: Lens' PutRecordsRequestEntry ByteString

-- | 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.
prrePartitionKey :: Lens' PutRecordsRequestEntry Text

-- | Represents the result of an individual record from a
--   <tt>PutRecords</tt> request. A record that is successfully added to a
--   stream includes <tt>SequenceNumber</tt> and <tt>ShardId</tt> in the
--   result. A record that fails to be added to the stream includes
--   <tt>ErrorCode</tt> and <tt>ErrorMessage</tt> in the result.
--   
--   <i>See:</i> <a>putRecordsResultEntry</a> smart constructor.
data PutRecordsResultEntry

-- | Creates a value of <a>PutRecordsResultEntry</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>prreSequenceNumber</a> - The sequence number for an individual
--   record result.</li>
--   <li><a>prreErrorCode</a> - The error code for an individual record
--   result. <tt>ErrorCodes</tt> can be either
--   <tt>ProvisionedThroughputExceededException</tt> or
--   <tt>InternalFailure</tt> .</li>
--   <li><a>prreErrorMessage</a> - The error message for an individual
--   record result. An <tt>ErrorCode</tt> value of
--   <tt>ProvisionedThroughputExceededException</tt> has an error message
--   that includes the account ID, stream name, and shard ID. An
--   <tt>ErrorCode</tt> value of <tt>InternalFailure</tt> has the error
--   message <tt>"Internal Service Failure"</tt> .</li>
--   <li><a>prreShardId</a> - The shard ID for an individual record
--   result.</li>
--   </ul>
putRecordsResultEntry :: PutRecordsResultEntry

-- | The sequence number for an individual record result.
prreSequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The error code for an individual record result. <tt>ErrorCodes</tt>
--   can be either <tt>ProvisionedThroughputExceededException</tt> or
--   <tt>InternalFailure</tt> .
prreErrorCode :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The error message for an individual record result. An
--   <tt>ErrorCode</tt> value of
--   <tt>ProvisionedThroughputExceededException</tt> has an error message
--   that includes the account ID, stream name, and shard ID. An
--   <tt>ErrorCode</tt> value of <tt>InternalFailure</tt> has the error
--   message <tt>"Internal Service Failure"</tt> .
prreErrorMessage :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The shard ID for an individual record result.
prreShardId :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The unit of data of the Kinesis data stream, which is composed of a
--   sequence number, a partition key, and a data blob.
--   
--   <i>See:</i> <a>record</a> smart constructor.
data Record

-- | Creates a value of <a>Record</a> with the minimum fields required to
--   make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>rEncryptionType</a> - The encryption type used on the record.
--   This parameter can be one of the following values: * <tt>NONE</tt> :
--   Do not encrypt the records in the stream. * <tt>KMS</tt> : Use
--   server-side encryption on the records in the stream using a
--   customer-managed AWS KMS key.</li>
--   <li><a>rApproximateArrivalTimestamp</a> - The approximate time that
--   the record was inserted into the stream.</li>
--   <li><a>rSequenceNumber</a> - The unique identifier of the record
--   within its shard.</li>
--   <li><a>rData</a> - 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).-- <i>Note:</i> This <tt>Lens</tt> automatically encodes and
--   decodes Base64 data. The underlying isomorphism will encode to Base64
--   representation during serialisation, and decode from Base64
--   representation during deserialisation. This <tt>Lens</tt> accepts and
--   returns only raw unencoded data.</li>
--   <li><a>rPartitionKey</a> - Identifies which shard in the stream the
--   data record is assigned to.</li>
--   </ul>
record :: Text -> ByteString -> Text -> Record

-- | The encryption type used on the record. This parameter can be one of
--   the following values: * <tt>NONE</tt> : Do not encrypt the records in
--   the stream. * <tt>KMS</tt> : Use server-side encryption on the records
--   in the stream using a customer-managed AWS KMS key.
rEncryptionType :: Lens' Record (Maybe EncryptionType)

-- | The approximate time that the record was inserted into the stream.
rApproximateArrivalTimestamp :: Lens' Record (Maybe UTCTime)

-- | The unique identifier of the record within its shard.
rSequenceNumber :: Lens' Record Text

-- | 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).-- <i>Note:</i> This
--   <tt>Lens</tt> automatically encodes and decodes Base64 data. The
--   underlying isomorphism will encode to Base64 representation during
--   serialisation, and decode from Base64 representation during
--   deserialisation. This <tt>Lens</tt> accepts and returns only raw
--   unencoded data.
rData :: Lens' Record ByteString

-- | Identifies which shard in the stream the data record is assigned to.
rPartitionKey :: Lens' Record Text

-- | The range of possible sequence numbers for the shard.
--   
--   <i>See:</i> <a>sequenceNumberRange</a> smart constructor.
data SequenceNumberRange

-- | Creates a value of <a>SequenceNumberRange</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>snrEndingSequenceNumber</a> - The ending sequence number for
--   the range. Shards that are in the OPEN state have an ending sequence
--   number of <tt>null</tt> .</li>
--   <li><a>snrStartingSequenceNumber</a> - The starting sequence number
--   for the range.</li>
--   </ul>
sequenceNumberRange :: Text -> SequenceNumberRange

-- | The ending sequence number for the range. Shards that are in the OPEN
--   state have an ending sequence number of <tt>null</tt> .
snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)

-- | The starting sequence number for the range.
snrStartingSequenceNumber :: Lens' SequenceNumberRange Text

-- | A uniquely identified group of data records in a Kinesis data stream.
--   
--   <i>See:</i> <a>shard</a> smart constructor.
data Shard

-- | Creates a value of <a>Shard</a> with the minimum fields required to
--   make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sAdjacentParentShardId</a> - The shard ID of the shard adjacent
--   to the shard's parent.</li>
--   <li><a>sParentShardId</a> - The shard ID of the shard's parent.</li>
--   <li><a>sShardId</a> - The unique identifier of the shard within the
--   stream.</li>
--   <li><a>sHashKeyRange</a> - The range of possible hash key values for
--   the shard, which is a set of ordered contiguous positive
--   integers.</li>
--   <li><a>sSequenceNumberRange</a> - The range of possible sequence
--   numbers for the shard.</li>
--   </ul>
shard :: Text -> HashKeyRange -> SequenceNumberRange -> Shard

-- | The shard ID of the shard adjacent to the shard's parent.
sAdjacentParentShardId :: Lens' Shard (Maybe Text)

-- | The shard ID of the shard's parent.
sParentShardId :: Lens' Shard (Maybe Text)

-- | The unique identifier of the shard within the stream.
sShardId :: Lens' Shard Text

-- | The range of possible hash key values for the shard, which is a set of
--   ordered contiguous positive integers.
sHashKeyRange :: Lens' Shard HashKeyRange

-- | The range of possible sequence numbers for the shard.
sSequenceNumberRange :: Lens' Shard SequenceNumberRange

-- | Represents the output for <tt>DescribeStream</tt> .
--   
--   <i>See:</i> <a>streamDescription</a> smart constructor.
data StreamDescription

-- | Creates a value of <a>StreamDescription</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sdEncryptionType</a> - The server-side encryption type used on
--   the stream. This parameter can be one of the following values: *
--   <tt>NONE</tt> : Do not encrypt the records in the stream. *
--   <tt>KMS</tt> : Use server-side encryption on the records in the stream
--   using a customer-managed AWS KMS key.</li>
--   <li><a>sdKeyId</a> - 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<i>".You can also use a master key owned by Kinesis
--   Data Streams by specifying the alias @aws</i>kinesis<tt> . * Key ARN
--   example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@</li>
--   <li><a>sdStreamName</a> - The name of the stream being described.</li>
--   <li><a>sdStreamARN</a> - The Amazon Resource Name (ARN) for the stream
--   being described.</li>
--   <li><a>sdStreamStatus</a> - The current status of the stream being
--   described. The stream status is one of the following states: *
--   <tt>CREATING</tt> - The stream is being created. Kinesis Data Streams
--   immediately returns and sets <tt>StreamStatus</tt> to
--   <tt>CREATING</tt> . * <tt>DELETING</tt> - The stream is being deleted.
--   The specified stream is in the <tt>DELETING</tt> state until Kinesis
--   Data Streams completes the deletion. * <tt>ACTIVE</tt> - The stream
--   exists and is ready for read and write operations or deletion. You
--   should perform read and write operations only on an <tt>ACTIVE</tt>
--   stream. * <tt>UPDATING</tt> - Shards in the stream are being merged or
--   split. Read and write operations continue to work while the stream is
--   in the <tt>UPDATING</tt> state.</li>
--   <li><a>sdShards</a> - The shards that comprise the stream.</li>
--   <li><a>sdHasMoreShards</a> - If set to <tt>true</tt> , more shards in
--   the stream are available to describe.</li>
--   <li><a>sdRetentionPeriodHours</a> - The current retention period, in
--   hours.</li>
--   <li><a>sdStreamCreationTimestamp</a> - The approximate time that the
--   stream was created.</li>
--   <li><a>sdEnhancedMonitoring</a> - Represents the current enhanced
--   monitoring settings of the stream.</li>
--   </ul>
streamDescription :: Text -> Text -> StreamStatus -> Bool -> Natural -> UTCTime -> StreamDescription

-- | The server-side encryption type used on the stream. This parameter can
--   be one of the following values: * <tt>NONE</tt> : Do not encrypt the
--   records in the stream. * <tt>KMS</tt> : Use server-side encryption on
--   the records in the stream using a customer-managed AWS KMS key.
sdEncryptionType :: Lens' StreamDescription (Maybe EncryptionType)

-- | 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<i>".You can also use a master key owned by Kinesis Data Streams
--   by specifying the alias @aws</i>kinesis<tt> . * Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@
sdKeyId :: Lens' StreamDescription (Maybe Text)

-- | The name of the stream being described.
sdStreamName :: Lens' StreamDescription Text

-- | The Amazon Resource Name (ARN) for the stream being described.
sdStreamARN :: Lens' StreamDescription Text

-- | The current status of the stream being described. The stream status is
--   one of the following states: * <tt>CREATING</tt> - The stream is being
--   created. Kinesis Data Streams immediately returns and sets
--   <tt>StreamStatus</tt> to <tt>CREATING</tt> . * <tt>DELETING</tt> - The
--   stream is being deleted. The specified stream is in the
--   <tt>DELETING</tt> state until Kinesis Data Streams completes the
--   deletion. * <tt>ACTIVE</tt> - The stream exists and is ready for read
--   and write operations or deletion. You should perform read and write
--   operations only on an <tt>ACTIVE</tt> stream. * <tt>UPDATING</tt> -
--   Shards in the stream are being merged or split. Read and write
--   operations continue to work while the stream is in the
--   <tt>UPDATING</tt> state.
sdStreamStatus :: Lens' StreamDescription StreamStatus

-- | The shards that comprise the stream.
sdShards :: Lens' StreamDescription [Shard]

-- | If set to <tt>true</tt> , more shards in the stream are available to
--   describe.
sdHasMoreShards :: Lens' StreamDescription Bool

-- | The current retention period, in hours.
sdRetentionPeriodHours :: Lens' StreamDescription Natural

-- | The approximate time that the stream was created.
sdStreamCreationTimestamp :: Lens' StreamDescription UTCTime

-- | Represents the current enhanced monitoring settings of the stream.
sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics]

-- | Represents the output for <tt>DescribeStreamSummary</tt>
--   
--   <i>See:</i> <a>streamDescriptionSummary</a> smart constructor.
data StreamDescriptionSummary

-- | Creates a value of <a>StreamDescriptionSummary</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sdsEncryptionType</a> - The encryption type used. This value is
--   one of the following: * <tt>KMS</tt> * <tt>NONE</tt></li>
--   <li><a>sdsKeyId</a> - 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<i>".You can also use a master key owned by Kinesis
--   Data Streams by specifying the alias @aws</i>kinesis<tt> . * Key ARN
--   example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@</li>
--   <li><a>sdsStreamName</a> - The name of the stream being
--   described.</li>
--   <li><a>sdsStreamARN</a> - The Amazon Resource Name (ARN) for the
--   stream being described.</li>
--   <li><a>sdsStreamStatus</a> - The current status of the stream being
--   described. The stream status is one of the following states: *
--   <tt>CREATING</tt> - The stream is being created. Kinesis Data Streams
--   immediately returns and sets <tt>StreamStatus</tt> to
--   <tt>CREATING</tt> . * <tt>DELETING</tt> - The stream is being deleted.
--   The specified stream is in the <tt>DELETING</tt> state until Kinesis
--   Data Streams completes the deletion. * <tt>ACTIVE</tt> - The stream
--   exists and is ready for read and write operations or deletion. You
--   should perform read and write operations only on an <tt>ACTIVE</tt>
--   stream. * <tt>UPDATING</tt> - Shards in the stream are being merged or
--   split. Read and write operations continue to work while the stream is
--   in the <tt>UPDATING</tt> state.</li>
--   <li><a>sdsRetentionPeriodHours</a> - The current retention period, in
--   hours.</li>
--   <li><a>sdsStreamCreationTimestamp</a> - The approximate time that the
--   stream was created.</li>
--   <li><a>sdsEnhancedMonitoring</a> - Represents the current enhanced
--   monitoring settings of the stream.</li>
--   <li><a>sdsOpenShardCount</a> - The number of open shards in the
--   stream.</li>
--   </ul>
streamDescriptionSummary :: Text -> Text -> StreamStatus -> Natural -> UTCTime -> Natural -> StreamDescriptionSummary

-- | The encryption type used. This value is one of the following: *
--   <tt>KMS</tt> * <tt>NONE</tt>
sdsEncryptionType :: Lens' StreamDescriptionSummary (Maybe EncryptionType)

-- | 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<i>".You can also use a master key owned by Kinesis Data Streams
--   by specifying the alias @aws</i>kinesis<tt> . * Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@
sdsKeyId :: Lens' StreamDescriptionSummary (Maybe Text)

-- | The name of the stream being described.
sdsStreamName :: Lens' StreamDescriptionSummary Text

-- | The Amazon Resource Name (ARN) for the stream being described.
sdsStreamARN :: Lens' StreamDescriptionSummary Text

-- | The current status of the stream being described. The stream status is
--   one of the following states: * <tt>CREATING</tt> - The stream is being
--   created. Kinesis Data Streams immediately returns and sets
--   <tt>StreamStatus</tt> to <tt>CREATING</tt> . * <tt>DELETING</tt> - The
--   stream is being deleted. The specified stream is in the
--   <tt>DELETING</tt> state until Kinesis Data Streams completes the
--   deletion. * <tt>ACTIVE</tt> - The stream exists and is ready for read
--   and write operations or deletion. You should perform read and write
--   operations only on an <tt>ACTIVE</tt> stream. * <tt>UPDATING</tt> -
--   Shards in the stream are being merged or split. Read and write
--   operations continue to work while the stream is in the
--   <tt>UPDATING</tt> state.
sdsStreamStatus :: Lens' StreamDescriptionSummary StreamStatus

-- | The current retention period, in hours.
sdsRetentionPeriodHours :: Lens' StreamDescriptionSummary Natural

-- | The approximate time that the stream was created.
sdsStreamCreationTimestamp :: Lens' StreamDescriptionSummary UTCTime

-- | Represents the current enhanced monitoring settings of the stream.
sdsEnhancedMonitoring :: Lens' StreamDescriptionSummary [EnhancedMetrics]

-- | The number of open shards in the stream.
sdsOpenShardCount :: Lens' StreamDescriptionSummary Natural

-- | Metadata assigned to the stream, consisting of a key-value pair.
--   
--   <i>See:</i> <a>tag</a> smart constructor.
data Tag

-- | Creates a value of <a>Tag</a> with the minimum fields required to make
--   a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>tagValue</a> - An optional string, typically used to describe
--   or define the tag. Maximum length: 256 characters. Valid characters:
--   Unicode letters, digits, white space, _ . / = + - % @</li>
--   <li><a>tagKey</a> - A unique identifier for the tag. Maximum length:
--   128 characters. Valid characters: Unicode letters, digits, white
--   space, _ . / = + - % @</li>
--   </ul>
tag :: Text -> Tag

-- | An optional string, typically used to describe or define the tag.
--   Maximum length: 256 characters. Valid characters: Unicode letters,
--   digits, white space, _ . / = + - % @
tagValue :: Lens' Tag (Maybe Text)

-- | A unique identifier for the tag. Maximum length: 128 characters. Valid
--   characters: Unicode letters, digits, white space, _ . / = + - % @
tagKey :: Lens' Tag Text


-- | Disables server-side encryption for a specified stream.
--   
--   Stopping encryption is an asynchronous operation. Upon receiving the
--   request, Kinesis Data Streams returns immediately and sets the status
--   of the stream to <tt>UPDATING</tt> . After the update is complete,
--   Kinesis Data Streams sets the status of the stream back to
--   <tt>ACTIVE</tt> . Stopping encryption normally takes a few seconds to
--   complete, but it can take minutes. You can continue to read and write
--   data to your stream while its status is <tt>UPDATING</tt> . Once the
--   status of the stream is <tt>ACTIVE</tt> , records written to the
--   stream are no longer encrypted by Kinesis Data Streams.
--   
--   API Limits: You can successfully disable server-side encryption 25
--   times in a rolling 24-hour period.
--   
--   Note: It can take up to five seconds after the stream is in an
--   <tt>ACTIVE</tt> status before all records written to the stream are no
--   longer subject to encryption. After you disabled encryption, you can
--   verify that encryption is not applied by inspecting the API response
--   from <tt>PutRecord</tt> or <tt>PutRecords</tt> .
module Network.AWS.Kinesis.StopStreamEncryption

-- | Creates a value of <a>StopStreamEncryption</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sseStreamName</a> - The name of the stream on which to stop
--   encrypting records.</li>
--   <li><a>sseEncryptionType</a> - The encryption type. The only valid
--   value is <tt>KMS</tt> .</li>
--   <li><a>sseKeyId</a> - The GUID for the customer-managed AWS 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<i>".You can also use a master
--   key owned by Kinesis Data Streams by specifying the alias
--   @aws</i>kinesis<tt> . * Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@</li>
--   </ul>
stopStreamEncryption :: Text -> EncryptionType -> Text -> StopStreamEncryption

-- | <i>See:</i> <a>stopStreamEncryption</a> smart constructor.
data StopStreamEncryption

-- | The name of the stream on which to stop encrypting records.
sseStreamName :: Lens' StopStreamEncryption Text

-- | The encryption type. The only valid value is <tt>KMS</tt> .
sseEncryptionType :: Lens' StopStreamEncryption EncryptionType

-- | The GUID for the customer-managed AWS 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<i>".You can also use a master key owned by
--   Kinesis Data Streams by specifying the alias @aws</i>kinesis<tt> . *
--   Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@
sseKeyId :: Lens' StopStreamEncryption Text

-- | Creates a value of <a>StopStreamEncryptionResponse</a> with the
--   minimum fields required to make a request.
stopStreamEncryptionResponse :: StopStreamEncryptionResponse

-- | <i>See:</i> <a>stopStreamEncryptionResponse</a> smart constructor.
data StopStreamEncryptionResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryptionResponse
instance Data.Data.Data Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryptionResponse
instance GHC.Show.Show Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryptionResponse
instance GHC.Read.Read Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryptionResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryptionResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Data.Data.Data Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance GHC.Show.Show Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance GHC.Read.Read Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance GHC.Classes.Eq Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Control.DeepSeq.NFData Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryptionResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Control.DeepSeq.NFData Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.StopStreamEncryption.StopStreamEncryption


-- | Enables or updates server-side encryption using an AWS KMS key for a
--   specified stream.
--   
--   Starting encryption is an asynchronous operation. Upon receiving the
--   request, Kinesis Data Streams returns immediately and sets the status
--   of the stream to <tt>UPDATING</tt> . After the update is complete,
--   Kinesis Data Streams sets the status of the stream back to
--   <tt>ACTIVE</tt> . Updating or applying encryption normally takes a few
--   seconds to complete, but it can take minutes. You can continue to read
--   and write data to your stream while its status is <tt>UPDATING</tt> .
--   Once the status of the stream is <tt>ACTIVE</tt> , encryption begins
--   for records written to the stream.
--   
--   API Limits: You can successfully apply a new AWS KMS key for
--   server-side encryption 25 times in a rolling 24-hour period.
--   
--   Note: It can take up to five seconds after the stream is in an
--   <tt>ACTIVE</tt> status before all records written to the stream are
--   encrypted. After you enable encryption, you can verify that encryption
--   is applied by inspecting the API response from <tt>PutRecord</tt> or
--   <tt>PutRecords</tt> .
module Network.AWS.Kinesis.StartStreamEncryption

-- | Creates a value of <a>StartStreamEncryption</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sStreamName</a> - The name of the stream for which to start
--   encrypting records.</li>
--   <li><a>sEncryptionType</a> - The encryption type to use. The only
--   valid value is <tt>KMS</tt> .</li>
--   <li><a>sKeyId</a> - The GUID for the customer-managed AWS 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<i>".You can also use a master
--   key owned by Kinesis Data Streams by specifying the alias
--   @aws</i>kinesis<tt> . * Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@</li>
--   </ul>
startStreamEncryption :: Text -> EncryptionType -> Text -> StartStreamEncryption

-- | <i>See:</i> <a>startStreamEncryption</a> smart constructor.
data StartStreamEncryption

-- | The name of the stream for which to start encrypting records.
sStreamName :: Lens' StartStreamEncryption Text

-- | The encryption type to use. The only valid value is <tt>KMS</tt> .
sEncryptionType :: Lens' StartStreamEncryption EncryptionType

-- | The GUID for the customer-managed AWS 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<i>".You can also use a master key owned by
--   Kinesis Data Streams by specifying the alias @aws</i>kinesis<tt> . *
--   Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@
sKeyId :: Lens' StartStreamEncryption Text

-- | Creates a value of <a>StartStreamEncryptionResponse</a> with the
--   minimum fields required to make a request.
startStreamEncryptionResponse :: StartStreamEncryptionResponse

-- | <i>See:</i> <a>startStreamEncryptionResponse</a> smart constructor.
data StartStreamEncryptionResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryptionResponse
instance Data.Data.Data Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryptionResponse
instance GHC.Show.Show Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryptionResponse
instance GHC.Read.Read Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryptionResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryptionResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Data.Data.Data Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance GHC.Show.Show Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance GHC.Read.Read Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance GHC.Classes.Eq Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Control.DeepSeq.NFData Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryptionResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Control.DeepSeq.NFData Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.StartStreamEncryption.StartStreamEncryption


-- | Splits a shard into two new shards in the Kinesis data stream, to
--   increase the stream's capacity to ingest and transport data.
--   <tt>SplitShard</tt> is called when there is a need to increase the
--   overall capacity of a stream because of an expected increase in the
--   volume of data records being ingested.
--   
--   You can also use <tt>SplitShard</tt> when a shard appears to be
--   approaching its maximum utilization; for example, the producers
--   sending data into the specific shard are suddenly sending more than
--   previously anticipated. You can also call <tt>SplitShard</tt> to
--   increase stream capacity, so that more Kinesis Data Streams
--   applications can simultaneously read data from the stream for
--   real-time processing.
--   
--   You must specify the shard to be split and the new hash key, which is
--   the position in the shard where the shard gets split in two. In many
--   cases, the new hash key might be the average of the beginning and
--   ending hash key, but it can be any hash key value in the range being
--   mapped into the shard. For more information, see <a>Split a Shard</a>
--   in the <i>Amazon Kinesis Data Streams Developer Guide</i> .
--   
--   You can use <tt>DescribeStream</tt> to determine the shard ID and hash
--   key values for the <tt>ShardToSplit</tt> and
--   <tt>NewStartingHashKey</tt> parameters that are specified in the
--   <tt>SplitShard</tt> request.
--   
--   <tt>SplitShard</tt> is an asynchronous operation. Upon receiving a
--   <tt>SplitShard</tt> request, Kinesis Data Streams immediately returns
--   a response and sets the stream status to <tt>UPDATING</tt> . After the
--   operation is completed, Kinesis Data Streams sets the stream status to
--   <tt>ACTIVE</tt> . Read and write operations continue to work while the
--   stream is in the <tt>UPDATING</tt> state.
--   
--   You can use <tt>DescribeStream</tt> to check the status of the stream,
--   which is returned in <tt>StreamStatus</tt> . If the stream is in the
--   <tt>ACTIVE</tt> state, you can call <tt>SplitShard</tt> . If a stream
--   is in <tt>CREATING</tt> or <tt>UPDATING</tt> or <tt>DELETING</tt>
--   states, <tt>DescribeStream</tt> returns a
--   <tt>ResourceInUseException</tt> .
--   
--   If the specified stream does not exist, <tt>DescribeStream</tt>
--   returns a <tt>ResourceNotFoundException</tt> . If you try to create
--   more shards than are authorized for your account, you receive a
--   <tt>LimitExceededException</tt> .
--   
--   For the default shard limit for an AWS account, see <a>Streams
--   Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i> .
--   To increase this limit, <a>contact AWS Support</a> .
--   
--   If you try to operate on too many streams simultaneously using
--   <tt>CreateStream</tt> , <tt>DeleteStream</tt> , <tt>MergeShards</tt> ,
--   and/or <a>SplitShard</a> , you receive a
--   <tt>LimitExceededException</tt> .
--   
--   <tt>SplitShard</tt> has a limit of five transactions per second per
--   account.
module Network.AWS.Kinesis.SplitShard

-- | Creates a value of <a>SplitShard</a> with the minimum fields required
--   to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>ssStreamName</a> - The name of the stream for the shard
--   split.</li>
--   <li><a>ssShardToSplit</a> - The shard ID of the shard to split.</li>
--   <li><a>ssNewStartingHashKey</a> - 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 <tt>NewStartingHashKey</tt> must be
--   in the range of hash keys being mapped into the shard. The
--   <tt>NewStartingHashKey</tt> 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.</li>
--   </ul>
splitShard :: Text -> Text -> Text -> SplitShard

-- | Represents the input for <tt>SplitShard</tt> .
--   
--   <i>See:</i> <a>splitShard</a> smart constructor.
data SplitShard

-- | The name of the stream for the shard split.
ssStreamName :: Lens' SplitShard Text

-- | The shard ID of the shard to split.
ssShardToSplit :: Lens' SplitShard Text

-- | 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
--   <tt>NewStartingHashKey</tt> must be in the range of hash keys being
--   mapped into the shard. The <tt>NewStartingHashKey</tt> 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.
ssNewStartingHashKey :: Lens' SplitShard Text

-- | Creates a value of <a>SplitShardResponse</a> with the minimum fields
--   required to make a request.
splitShardResponse :: SplitShardResponse

-- | <i>See:</i> <a>splitShardResponse</a> smart constructor.
data SplitShardResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.SplitShard.SplitShardResponse
instance Data.Data.Data Network.AWS.Kinesis.SplitShard.SplitShardResponse
instance GHC.Show.Show Network.AWS.Kinesis.SplitShard.SplitShardResponse
instance GHC.Read.Read Network.AWS.Kinesis.SplitShard.SplitShardResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.SplitShard.SplitShardResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.SplitShard.SplitShard
instance Data.Data.Data Network.AWS.Kinesis.SplitShard.SplitShard
instance GHC.Show.Show Network.AWS.Kinesis.SplitShard.SplitShard
instance GHC.Read.Read Network.AWS.Kinesis.SplitShard.SplitShard
instance GHC.Classes.Eq Network.AWS.Kinesis.SplitShard.SplitShard
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.SplitShard.SplitShard
instance Control.DeepSeq.NFData Network.AWS.Kinesis.SplitShard.SplitShardResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.SplitShard.SplitShard
instance Control.DeepSeq.NFData Network.AWS.Kinesis.SplitShard.SplitShard
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.SplitShard.SplitShard
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.SplitShard.SplitShard
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.SplitShard.SplitShard
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.SplitShard.SplitShard


-- | Removes tags from the specified Kinesis data stream. Removed tags are
--   deleted and cannot be recovered after this operation successfully
--   completes.
--   
--   If you specify a tag that does not exist, it is ignored.
--   
--   <a>RemoveTagsFromStream</a> has a limit of five transactions per
--   second per account.
module Network.AWS.Kinesis.RemoveTagsFromStream

-- | Creates a value of <a>RemoveTagsFromStream</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>rtfsStreamName</a> - The name of the stream.</li>
--   <li><a>rtfsTagKeys</a> - A list of tag keys. Each corresponding tag is
--   removed from the stream.</li>
--   </ul>
removeTagsFromStream :: Text -> NonEmpty Text -> RemoveTagsFromStream

-- | Represents the input for <tt>RemoveTagsFromStream</tt> .
--   
--   <i>See:</i> <a>removeTagsFromStream</a> smart constructor.
data RemoveTagsFromStream

-- | The name of the stream.
rtfsStreamName :: Lens' RemoveTagsFromStream Text

-- | A list of tag keys. Each corresponding tag is removed from the stream.
rtfsTagKeys :: Lens' RemoveTagsFromStream (NonEmpty Text)

-- | Creates a value of <a>RemoveTagsFromStreamResponse</a> with the
--   minimum fields required to make a request.
removeTagsFromStreamResponse :: RemoveTagsFromStreamResponse

-- | <i>See:</i> <a>removeTagsFromStreamResponse</a> smart constructor.
data RemoveTagsFromStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStreamResponse
instance Data.Data.Data Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStreamResponse
instance GHC.Show.Show Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStreamResponse
instance GHC.Read.Read Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStreamResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Data.Data.Data Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance GHC.Show.Show Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance GHC.Read.Read Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance GHC.Classes.Eq Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStreamResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.RemoveTagsFromStream.RemoveTagsFromStream


-- | Writes multiple data records into a Kinesis data stream in a single
--   call (also referred to as a <tt>PutRecords</tt> request). Use this
--   operation to send data into the stream for data ingestion and
--   processing.
--   
--   Each <tt>PutRecords</tt> request can support up to 500 records. Each
--   record in the request can be as large as 1 MB, up to a limit of 5 MB
--   for the entire request, including partition keys. Each shard can
--   support writes up to 1,000 records per second, up to a maximum data
--   write total of 1 MB per second.
--   
--   You must specify the name of the stream that captures, stores, and
--   transports the data; and an array of request <tt>Records</tt> , with
--   each record in the array requiring a partition key and data blob. The
--   record size limit applies to the total size of the partition key and
--   data blob.
--   
--   The data blob can be any type of data; for example, a segment from a
--   log file, geographic/location data, website clickstream data, and so
--   on.
--   
--   The partition key is used by Kinesis Data Streams as input to a hash
--   function that maps the partition key and associated data to a specific
--   shard. 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. For more
--   information, see <a>Adding Data to a Stream</a> in the <i>Amazon
--   Kinesis Data Streams Developer Guide</i> .
--   
--   Each record in the <tt>Records</tt> array may include an optional
--   parameter, <tt>ExplicitHashKey</tt> , which overrides the partition
--   key to shard mapping. This parameter allows a data producer to
--   determine explicitly the shard where the record is stored. For more
--   information, see <a>Adding Multiple Records with PutRecords</a> in the
--   <i>Amazon Kinesis Data Streams Developer Guide</i> .
--   
--   The <tt>PutRecords</tt> response includes an array of response
--   <tt>Records</tt> . Each record in the response array directly
--   correlates with a record in the request array using natural ordering,
--   from the top to the bottom of the request and response. The response
--   <tt>Records</tt> array always includes the same number of records as
--   the request array.
--   
--   The response <tt>Records</tt> array includes both successfully and
--   unsuccessfully processed records. Kinesis Data Streams attempts to
--   process all records in each <tt>PutRecords</tt> request. A single
--   record failure does not stop the processing of subsequent records.
--   
--   A successfully processed record includes <tt>ShardId</tt> and
--   <tt>SequenceNumber</tt> values. The <tt>ShardId</tt> parameter
--   identifies the shard in the stream where the record is stored. The
--   <tt>SequenceNumber</tt> parameter is an identifier assigned to the put
--   record, unique to all records in the stream.
--   
--   An unsuccessfully processed record includes <tt>ErrorCode</tt> and
--   <tt>ErrorMessage</tt> values. <tt>ErrorCode</tt> reflects the type of
--   error and can be one of the following values:
--   <tt>ProvisionedThroughputExceededException</tt> or
--   <tt>InternalFailure</tt> . <tt>ErrorMessage</tt> provides more
--   detailed information about the
--   <tt>ProvisionedThroughputExceededException</tt> exception including
--   the account ID, stream name, and shard ID of the record that was
--   throttled. For more information about partially successful responses,
--   see <a>Adding Multiple Records with PutRecords</a> in the <i>Amazon
--   Kinesis Data Streams Developer Guide</i> .
--   
--   By default, data records are accessible for 24 hours from the time
--   that they are added to a stream. You can use
--   <tt>IncreaseStreamRetentionPeriod</tt> or
--   <tt>DecreaseStreamRetentionPeriod</tt> to modify this retention
--   period.
module Network.AWS.Kinesis.PutRecords

-- | Creates a value of <a>PutRecords</a> with the minimum fields required
--   to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>pRecordEntries</a> - The records associated with the
--   request.</li>
--   <li><a>pStreamName</a> - The stream name associated with the
--   request.</li>
--   </ul>
putRecords :: NonEmpty PutRecordsRequestEntry -> Text -> PutRecords

-- | A <tt>PutRecords</tt> request.
--   
--   <i>See:</i> <a>putRecords</a> smart constructor.
data PutRecords

-- | The records associated with the request.
pRecordEntries :: Lens' PutRecords (NonEmpty PutRecordsRequestEntry)

-- | The stream name associated with the request.
pStreamName :: Lens' PutRecords Text

-- | Creates a value of <a>PutRecordsResponse</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>prsEncryptionType</a> - The encryption type used on the
--   records. This parameter can be one of the following values: *
--   <tt>NONE</tt> : Do not encrypt the records. * <tt>KMS</tt> : Use
--   server-side encryption on the records using a customer-managed AWS KMS
--   key.</li>
--   <li><a>prsFailedRecordCount</a> - The number of unsuccessfully
--   processed records in a <tt>PutRecords</tt> request.</li>
--   <li><a>prsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>prsRecords</a> - An array of successfully and unsuccessfully
--   processed record results, correlated with the request by natural
--   ordering. A record that is successfully added to a stream includes
--   <tt>SequenceNumber</tt> and <tt>ShardId</tt> in the result. A record
--   that fails to be added to a stream includes <tt>ErrorCode</tt> and
--   <tt>ErrorMessage</tt> in the result.</li>
--   </ul>
putRecordsResponse :: Int -> NonEmpty PutRecordsResultEntry -> PutRecordsResponse

-- | <tt>PutRecords</tt> results.
--   
--   <i>See:</i> <a>putRecordsResponse</a> smart constructor.
data PutRecordsResponse

-- | The encryption type used on the records. This parameter can be one of
--   the following values: * <tt>NONE</tt> : Do not encrypt the records. *
--   <tt>KMS</tt> : Use server-side encryption on the records using a
--   customer-managed AWS KMS key.
prsEncryptionType :: Lens' PutRecordsResponse (Maybe EncryptionType)

-- | The number of unsuccessfully processed records in a
--   <tt>PutRecords</tt> request.
prsFailedRecordCount :: Lens' PutRecordsResponse (Maybe Natural)

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
prsResponseStatus :: Lens' PutRecordsResponse Int

-- | An array of successfully and unsuccessfully processed record results,
--   correlated with the request by natural ordering. A record that is
--   successfully added to a stream includes <tt>SequenceNumber</tt> and
--   <tt>ShardId</tt> in the result. A record that fails to be added to a
--   stream includes <tt>ErrorCode</tt> and <tt>ErrorMessage</tt> in the
--   result.
prsRecords :: Lens' PutRecordsResponse (NonEmpty PutRecordsResultEntry)
instance GHC.Generics.Generic Network.AWS.Kinesis.PutRecords.PutRecordsResponse
instance Data.Data.Data Network.AWS.Kinesis.PutRecords.PutRecordsResponse
instance GHC.Show.Show Network.AWS.Kinesis.PutRecords.PutRecordsResponse
instance GHC.Read.Read Network.AWS.Kinesis.PutRecords.PutRecordsResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.PutRecords.PutRecordsResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.PutRecords.PutRecords
instance Data.Data.Data Network.AWS.Kinesis.PutRecords.PutRecords
instance GHC.Show.Show Network.AWS.Kinesis.PutRecords.PutRecords
instance GHC.Read.Read Network.AWS.Kinesis.PutRecords.PutRecords
instance GHC.Classes.Eq Network.AWS.Kinesis.PutRecords.PutRecords
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.PutRecords.PutRecords
instance Control.DeepSeq.NFData Network.AWS.Kinesis.PutRecords.PutRecordsResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.PutRecords.PutRecords
instance Control.DeepSeq.NFData Network.AWS.Kinesis.PutRecords.PutRecords
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.PutRecords.PutRecords
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.PutRecords.PutRecords
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.PutRecords.PutRecords
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.PutRecords.PutRecords


-- | Writes a single data record into an Amazon Kinesis data stream. Call
--   <tt>PutRecord</tt> to send data into the stream for real-time
--   ingestion and subsequent processing, one record at a time. Each shard
--   can support writes up to 1,000 records per second, up to a maximum
--   data write total of 1 MB per second.
--   
--   You must specify the name of the stream that captures, stores, and
--   transports the data; a partition key; and the data blob itself.
--   
--   The data blob can be any type of data; for example, a segment from a
--   log file, geographic/location data, website clickstream data, and so
--   on.
--   
--   The partition key is used by Kinesis Data Streams to distribute data
--   across shards. Kinesis Data Streams segregates the data records that
--   belong to a stream into multiple shards, using the partition key
--   associated with each data record to determine the shard to which a
--   given data record belongs.
--   
--   Partition keys are Unicode strings, with a maximum length limit of 256
--   characters for each key. An MD5 hash function is used to map partition
--   keys to 128-bit integer values and to map associated data records to
--   shards using the hash key ranges of the shards. You can override
--   hashing the partition key to determine the shard by explicitly
--   specifying a hash value using the <tt>ExplicitHashKey</tt> parameter.
--   For more information, see <a>Adding Data to a Stream</a> in the
--   <i>Amazon Kinesis Data Streams Developer Guide</i> .
--   
--   <tt>PutRecord</tt> returns the shard ID of where the data record was
--   placed and the sequence number that was assigned to the data record.
--   
--   Sequence numbers increase over time and are specific to a shard within
--   a stream, not across all shards within a stream. To guarantee strictly
--   increasing ordering, write serially to a shard and use the
--   <tt>SequenceNumberForOrdering</tt> parameter. For more information,
--   see <a>Adding Data to a Stream</a> in the <i>Amazon Kinesis Data
--   Streams Developer Guide</i> .
--   
--   If a <tt>PutRecord</tt> request cannot be processed because of
--   insufficient provisioned throughput on the shard involved in the
--   request, <tt>PutRecord</tt> throws
--   <tt>ProvisionedThroughputExceededException</tt> .
--   
--   By default, data records are accessible for 24 hours from the time
--   that they are added to a stream. You can use
--   <tt>IncreaseStreamRetentionPeriod</tt> or
--   <tt>DecreaseStreamRetentionPeriod</tt> to modify this retention
--   period.
module Network.AWS.Kinesis.PutRecord

-- | Creates a value of <a>PutRecord</a> with the minimum fields required
--   to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>prExplicitHashKey</a> - The hash value used to explicitly
--   determine the shard the data record is assigned to by overriding the
--   partition key hash.</li>
--   <li><a>prSequenceNumberForOrdering</a> - Guarantees strictly
--   increasing sequence numbers, for puts from the same client and to the
--   same partition key. Usage: set the <tt>SequenceNumberForOrdering</tt>
--   of record <i>n</i> to the sequence number of record <i>n-1</i> (as
--   returned in the result when putting record <i>n-1</i> ). If this
--   parameter is not set, records are coarsely ordered based on arrival
--   time.</li>
--   <li><a>prStreamName</a> - The name of the stream to put the data
--   record into.</li>
--   <li><a>prData</a> - 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).--
--   <i>Note:</i> This <tt>Lens</tt> automatically encodes and decodes
--   Base64 data. The underlying isomorphism will encode to Base64
--   representation during serialisation, and decode from Base64
--   representation during deserialisation. This <tt>Lens</tt> accepts and
--   returns only raw unencoded data.</li>
--   <li><a>prPartitionKey</a> - 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.</li>
--   </ul>
putRecord :: Text -> ByteString -> Text -> PutRecord

-- | Represents the input for <tt>PutRecord</tt> .
--   
--   <i>See:</i> <a>putRecord</a> smart constructor.
data PutRecord

-- | The hash value used to explicitly determine the shard the data record
--   is assigned to by overriding the partition key hash.
prExplicitHashKey :: Lens' PutRecord (Maybe Text)

-- | Guarantees strictly increasing sequence numbers, for puts from the
--   same client and to the same partition key. Usage: set the
--   <tt>SequenceNumberForOrdering</tt> of record <i>n</i> to the sequence
--   number of record <i>n-1</i> (as returned in the result when putting
--   record <i>n-1</i> ). If this parameter is not set, records are
--   coarsely ordered based on arrival time.
prSequenceNumberForOrdering :: Lens' PutRecord (Maybe Text)

-- | The name of the stream to put the data record into.
prStreamName :: Lens' PutRecord Text

-- | 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).-- <i>Note:</i> This
--   <tt>Lens</tt> automatically encodes and decodes Base64 data. The
--   underlying isomorphism will encode to Base64 representation during
--   serialisation, and decode from Base64 representation during
--   deserialisation. This <tt>Lens</tt> accepts and returns only raw
--   unencoded data.
prData :: Lens' PutRecord ByteString

-- | 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.
prPartitionKey :: Lens' PutRecord Text

-- | Creates a value of <a>PutRecordResponse</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>prrsEncryptionType</a> - The encryption type to use on the
--   record. This parameter can be one of the following values: *
--   <tt>NONE</tt> : Do not encrypt the records in the stream. *
--   <tt>KMS</tt> : Use server-side encryption on the records in the stream
--   using a customer-managed AWS KMS key.</li>
--   <li><a>prrsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>prrsShardId</a> - The shard ID of the shard where the data
--   record was placed.</li>
--   <li><a>prrsSequenceNumber</a> - 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.</li>
--   </ul>
putRecordResponse :: Int -> Text -> Text -> PutRecordResponse

-- | Represents the output for <tt>PutRecord</tt> .
--   
--   <i>See:</i> <a>putRecordResponse</a> smart constructor.
data PutRecordResponse

-- | The encryption type to use on the record. This parameter can be one of
--   the following values: * <tt>NONE</tt> : Do not encrypt the records in
--   the stream. * <tt>KMS</tt> : Use server-side encryption on the records
--   in the stream using a customer-managed AWS KMS key.
prrsEncryptionType :: Lens' PutRecordResponse (Maybe EncryptionType)

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
prrsResponseStatus :: Lens' PutRecordResponse Int

-- | The shard ID of the shard where the data record was placed.
prrsShardId :: Lens' PutRecordResponse Text

-- | 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.
prrsSequenceNumber :: Lens' PutRecordResponse Text
instance GHC.Generics.Generic Network.AWS.Kinesis.PutRecord.PutRecordResponse
instance Data.Data.Data Network.AWS.Kinesis.PutRecord.PutRecordResponse
instance GHC.Show.Show Network.AWS.Kinesis.PutRecord.PutRecordResponse
instance GHC.Read.Read Network.AWS.Kinesis.PutRecord.PutRecordResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.PutRecord.PutRecordResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.PutRecord.PutRecord
instance Data.Data.Data Network.AWS.Kinesis.PutRecord.PutRecord
instance GHC.Show.Show Network.AWS.Kinesis.PutRecord.PutRecord
instance GHC.Read.Read Network.AWS.Kinesis.PutRecord.PutRecord
instance GHC.Classes.Eq Network.AWS.Kinesis.PutRecord.PutRecord
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.PutRecord.PutRecord
instance Control.DeepSeq.NFData Network.AWS.Kinesis.PutRecord.PutRecordResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.PutRecord.PutRecord
instance Control.DeepSeq.NFData Network.AWS.Kinesis.PutRecord.PutRecord
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.PutRecord.PutRecord
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.PutRecord.PutRecord
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.PutRecord.PutRecord
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.PutRecord.PutRecord


-- | Merges two adjacent shards in a Kinesis data stream and combines them
--   into a single shard to reduce the stream's capacity to ingest and
--   transport data. Two shards are considered adjacent if the union of the
--   hash key ranges for the two shards form a contiguous set with no gaps.
--   For example, if you have two shards, one with a hash key range of
--   276...381 and the other with a hash key range of 382...454, then you
--   could merge these two shards into a single shard that would have a
--   hash key range of 276...454. After the merge, the single child shard
--   receives data for all hash key values covered by the two parent
--   shards.
--   
--   <tt>MergeShards</tt> is called when there is a need to reduce the
--   overall capacity of a stream because of excess capacity that is not
--   being used. You must specify the shard to be merged and the adjacent
--   shard for a stream. For more information about merging shards, see
--   <a>Merge Two Shards</a> in the <i>Amazon Kinesis Data Streams
--   Developer Guide</i> .
--   
--   If the stream is in the <tt>ACTIVE</tt> state, you can call
--   <tt>MergeShards</tt> . If a stream is in the <tt>CREATING</tt> ,
--   <tt>UPDATING</tt> , or <tt>DELETING</tt> state, <tt>MergeShards</tt>
--   returns a <tt>ResourceInUseException</tt> . If the specified stream
--   does not exist, <tt>MergeShards</tt> returns a
--   <tt>ResourceNotFoundException</tt> .
--   
--   You can use <tt>DescribeStream</tt> to check the state of the stream,
--   which is returned in <tt>StreamStatus</tt> .
--   
--   <tt>MergeShards</tt> is an asynchronous operation. Upon receiving a
--   <tt>MergeShards</tt> request, Amazon Kinesis Data Streams immediately
--   returns a response and sets the <tt>StreamStatus</tt> to
--   <tt>UPDATING</tt> . After the operation is completed, Kinesis Data
--   Streams sets the <tt>StreamStatus</tt> to <tt>ACTIVE</tt> . Read and
--   write operations continue to work while the stream is in the
--   <tt>UPDATING</tt> state.
--   
--   You use <tt>DescribeStream</tt> to determine the shard IDs that are
--   specified in the <tt>MergeShards</tt> request.
--   
--   If you try to operate on too many streams in parallel using
--   <tt>CreateStream</tt> , <tt>DeleteStream</tt> , <tt>MergeShards</tt> ,
--   or <tt>SplitShard</tt> , you receive a <tt>LimitExceededException</tt>
--   .
--   
--   <tt>MergeShards</tt> has a limit of five transactions per second per
--   account.
module Network.AWS.Kinesis.MergeShards

-- | Creates a value of <a>MergeShards</a> with the minimum fields required
--   to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>msStreamName</a> - The name of the stream for the merge.</li>
--   <li><a>msShardToMerge</a> - The shard ID of the shard to combine with
--   the adjacent shard for the merge.</li>
--   <li><a>msAdjacentShardToMerge</a> - The shard ID of the adjacent shard
--   for the merge.</li>
--   </ul>
mergeShards :: Text -> Text -> Text -> MergeShards

-- | Represents the input for <tt>MergeShards</tt> .
--   
--   <i>See:</i> <a>mergeShards</a> smart constructor.
data MergeShards

-- | The name of the stream for the merge.
msStreamName :: Lens' MergeShards Text

-- | The shard ID of the shard to combine with the adjacent shard for the
--   merge.
msShardToMerge :: Lens' MergeShards Text

-- | The shard ID of the adjacent shard for the merge.
msAdjacentShardToMerge :: Lens' MergeShards Text

-- | Creates a value of <a>MergeShardsResponse</a> with the minimum fields
--   required to make a request.
mergeShardsResponse :: MergeShardsResponse

-- | <i>See:</i> <a>mergeShardsResponse</a> smart constructor.
data MergeShardsResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.MergeShards.MergeShardsResponse
instance Data.Data.Data Network.AWS.Kinesis.MergeShards.MergeShardsResponse
instance GHC.Show.Show Network.AWS.Kinesis.MergeShards.MergeShardsResponse
instance GHC.Read.Read Network.AWS.Kinesis.MergeShards.MergeShardsResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.MergeShards.MergeShardsResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.MergeShards.MergeShards
instance Data.Data.Data Network.AWS.Kinesis.MergeShards.MergeShards
instance GHC.Show.Show Network.AWS.Kinesis.MergeShards.MergeShards
instance GHC.Read.Read Network.AWS.Kinesis.MergeShards.MergeShards
instance GHC.Classes.Eq Network.AWS.Kinesis.MergeShards.MergeShards
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.MergeShards.MergeShards
instance Control.DeepSeq.NFData Network.AWS.Kinesis.MergeShards.MergeShardsResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.MergeShards.MergeShards
instance Control.DeepSeq.NFData Network.AWS.Kinesis.MergeShards.MergeShards
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.MergeShards.MergeShards
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.MergeShards.MergeShards
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.MergeShards.MergeShards
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.MergeShards.MergeShards


-- | Lists the tags for the specified Kinesis data stream. This operation
--   has a limit of five transactions per second per account.
module Network.AWS.Kinesis.ListTagsForStream

-- | Creates a value of <a>ListTagsForStream</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>ltfsLimit</a> - The number of tags to return. If this number is
--   less than the total number of tags associated with the stream,
--   <tt>HasMoreTags</tt> is set to <tt>true</tt> . To list additional
--   tags, set <tt>ExclusiveStartTagKey</tt> to the last key in the
--   response.</li>
--   <li><a>ltfsExclusiveStartTagKey</a> - The key to use as the starting
--   point for the list of tags. If this parameter is set,
--   <tt>ListTagsForStream</tt> gets all tags that occur after
--   <tt>ExclusiveStartTagKey</tt> .</li>
--   <li><a>ltfsStreamName</a> - The name of the stream.</li>
--   </ul>
listTagsForStream :: Text -> ListTagsForStream

-- | Represents the input for <tt>ListTagsForStream</tt> .
--   
--   <i>See:</i> <a>listTagsForStream</a> smart constructor.
data ListTagsForStream

-- | The number of tags to return. If this number is less than the total
--   number of tags associated with the stream, <tt>HasMoreTags</tt> is set
--   to <tt>true</tt> . To list additional tags, set
--   <tt>ExclusiveStartTagKey</tt> to the last key in the response.
ltfsLimit :: Lens' ListTagsForStream (Maybe Natural)

-- | The key to use as the starting point for the list of tags. If this
--   parameter is set, <tt>ListTagsForStream</tt> gets all tags that occur
--   after <tt>ExclusiveStartTagKey</tt> .
ltfsExclusiveStartTagKey :: Lens' ListTagsForStream (Maybe Text)

-- | The name of the stream.
ltfsStreamName :: Lens' ListTagsForStream Text

-- | Creates a value of <a>ListTagsForStreamResponse</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>ltfsrsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>ltfsrsTags</a> - A list of tags associated with
--   <tt>StreamName</tt> , starting with the first tag after
--   <tt>ExclusiveStartTagKey</tt> and up to the specified <tt>Limit</tt>
--   .</li>
--   <li><a>ltfsrsHasMoreTags</a> - If set to <tt>true</tt> , more tags are
--   available. To request additional tags, set
--   <tt>ExclusiveStartTagKey</tt> to the key of the last tag
--   returned.</li>
--   </ul>
listTagsForStreamResponse :: Int -> Bool -> ListTagsForStreamResponse

-- | Represents the output for <tt>ListTagsForStream</tt> .
--   
--   <i>See:</i> <a>listTagsForStreamResponse</a> smart constructor.
data ListTagsForStreamResponse

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
ltfsrsResponseStatus :: Lens' ListTagsForStreamResponse Int

-- | A list of tags associated with <tt>StreamName</tt> , starting with the
--   first tag after <tt>ExclusiveStartTagKey</tt> and up to the specified
--   <tt>Limit</tt> .
ltfsrsTags :: Lens' ListTagsForStreamResponse [Tag]

-- | If set to <tt>true</tt> , more tags are available. To request
--   additional tags, set <tt>ExclusiveStartTagKey</tt> to the key of the
--   last tag returned.
ltfsrsHasMoreTags :: Lens' ListTagsForStreamResponse Bool
instance GHC.Generics.Generic Network.AWS.Kinesis.ListTagsForStream.ListTagsForStreamResponse
instance Data.Data.Data Network.AWS.Kinesis.ListTagsForStream.ListTagsForStreamResponse
instance GHC.Show.Show Network.AWS.Kinesis.ListTagsForStream.ListTagsForStreamResponse
instance GHC.Read.Read Network.AWS.Kinesis.ListTagsForStream.ListTagsForStreamResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.ListTagsForStream.ListTagsForStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Data.Data.Data Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance GHC.Show.Show Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance GHC.Read.Read Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance GHC.Classes.Eq Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.ListTagsForStream.ListTagsForStreamResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.ListTagsForStream.ListTagsForStream


-- | Lists your Kinesis data streams.
--   
--   The number of streams may be too large to return from a single call to
--   <tt>ListStreams</tt> . You can limit the number of returned streams
--   using the <tt>Limit</tt> parameter. If you do not specify a value for
--   the <tt>Limit</tt> parameter, Kinesis Data Streams uses the default
--   limit, which is currently 10.
--   
--   You can detect if there are more streams available to list by using
--   the <tt>HasMoreStreams</tt> flag from the returned output. If there
--   are more streams available, you can request more streams by using the
--   name of the last stream returned by the <tt>ListStreams</tt> request
--   in the <tt>ExclusiveStartStreamName</tt> parameter in a subsequent
--   request to <tt>ListStreams</tt> . The group of stream names returned
--   by the subsequent request is then added to the list. You can continue
--   this process until all the stream names have been collected in the
--   list.
--   
--   <a>ListStreams</a> has a limit of five transactions per second per
--   account.
--   
--   This operation returns paginated results.
module Network.AWS.Kinesis.ListStreams

-- | Creates a value of <a>ListStreams</a> with the minimum fields required
--   to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>lsLimit</a> - The maximum number of streams to list.</li>
--   <li><a>lsExclusiveStartStreamName</a> - The name of the stream to
--   start the list with.</li>
--   </ul>
listStreams :: ListStreams

-- | Represents the input for <tt>ListStreams</tt> .
--   
--   <i>See:</i> <a>listStreams</a> smart constructor.
data ListStreams

-- | The maximum number of streams to list.
lsLimit :: Lens' ListStreams (Maybe Natural)

-- | The name of the stream to start the list with.
lsExclusiveStartStreamName :: Lens' ListStreams (Maybe Text)

-- | Creates a value of <a>ListStreamsResponse</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>lsrsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>lsrsStreamNames</a> - The names of the streams that are
--   associated with the AWS account making the <tt>ListStreams</tt>
--   request.</li>
--   <li><a>lsrsHasMoreStreams</a> - If set to <tt>true</tt> , there are
--   more streams available to list.</li>
--   </ul>
listStreamsResponse :: Int -> Bool -> ListStreamsResponse

-- | Represents the output for <tt>ListStreams</tt> .
--   
--   <i>See:</i> <a>listStreamsResponse</a> smart constructor.
data ListStreamsResponse

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
lsrsResponseStatus :: Lens' ListStreamsResponse Int

-- | The names of the streams that are associated with the AWS account
--   making the <tt>ListStreams</tt> request.
lsrsStreamNames :: Lens' ListStreamsResponse [Text]

-- | If set to <tt>true</tt> , there are more streams available to list.
lsrsHasMoreStreams :: Lens' ListStreamsResponse Bool
instance GHC.Generics.Generic Network.AWS.Kinesis.ListStreams.ListStreamsResponse
instance Data.Data.Data Network.AWS.Kinesis.ListStreams.ListStreamsResponse
instance GHC.Show.Show Network.AWS.Kinesis.ListStreams.ListStreamsResponse
instance GHC.Read.Read Network.AWS.Kinesis.ListStreams.ListStreamsResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.ListStreams.ListStreamsResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.ListStreams.ListStreams
instance Data.Data.Data Network.AWS.Kinesis.ListStreams.ListStreams
instance GHC.Show.Show Network.AWS.Kinesis.ListStreams.ListStreams
instance GHC.Read.Read Network.AWS.Kinesis.ListStreams.ListStreams
instance GHC.Classes.Eq Network.AWS.Kinesis.ListStreams.ListStreams
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.ListStreams.ListStreams
instance Control.DeepSeq.NFData Network.AWS.Kinesis.ListStreams.ListStreamsResponse
instance Network.AWS.Pager.AWSPager Network.AWS.Kinesis.ListStreams.ListStreams
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.ListStreams.ListStreams
instance Control.DeepSeq.NFData Network.AWS.Kinesis.ListStreams.ListStreams
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.ListStreams.ListStreams
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.ListStreams.ListStreams
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.ListStreams.ListStreams
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.ListStreams.ListStreams


-- | Lists the shards in a stream and provides information about each
--   shard.
--   
--   <i>Important:</i> This API is a new operation that is used by the
--   Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM
--   policy that only allows specific operations, you must update your
--   policy to allow calls to this API. For more information, see
--   <a>Controlling Access to Amazon Kinesis Data Streams Resources Using
--   IAM</a> .
module Network.AWS.Kinesis.ListShards

-- | Creates a value of <a>ListShards</a> with the minimum fields required
--   to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>lsNextToken</a> - When the number of shards in the data stream
--   is greater than the default value for the <tt>MaxResults</tt>
--   parameter, or if you explicitly specify a value for
--   <tt>MaxResults</tt> that is less than the number of shards in the data
--   stream, the response includes a pagination token named
--   <tt>NextToken</tt> . You can specify this <tt>NextToken</tt> value in
--   a subsequent call to <tt>ListShards</tt> to list the next set of
--   shards. Don't specify <tt>StreamName</tt> or
--   <tt>StreamCreationTimestamp</tt> if you specify <tt>NextToken</tt>
--   because the latter unambiguously identifies the stream. You can
--   optionally specify a value for the <tt>MaxResults</tt> parameter when
--   you specify <tt>NextToken</tt> . If you specify a <tt>MaxResults</tt>
--   value that is less than the number of shards that the operation
--   returns if you don't specify <tt>MaxResults</tt> , the response will
--   contain a new <tt>NextToken</tt> value. You can use the new
--   <tt>NextToken</tt> value in a subsequent call to the
--   <tt>ListShards</tt> operation. <i>Important:</i> Tokens expire after
--   300 seconds. When you obtain a value for <tt>NextToken</tt> in the
--   response to a call to <tt>ListShards</tt> , you have 300 seconds to
--   use that value. If you specify an expired token in a call to
--   <tt>ListShards</tt> , you get <tt>ExpiredNextTokenException</tt>
--   .</li>
--   <li><a>lsExclusiveStartShardId</a> - The ID of the shard to start the
--   list with. If you don't specify this parameter, the default behavior
--   is for <tt>ListShards</tt> to list the shards starting with the first
--   one in the stream. You cannot specify this parameter if you specify
--   <tt>NextToken</tt> .</li>
--   <li><a>lsStreamCreationTimestamp</a> - 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 <tt>NextToken</tt>
--   parameter.</li>
--   <li><a>lsStreamName</a> - The name of the data stream whose shards you
--   want to list. You cannot specify this parameter if you specify the
--   <tt>NextToken</tt> parameter.</li>
--   <li><a>lsMaxResults</a> - The maximum number of shards to return in a
--   single call to <tt>ListShards</tt> . The minimum value you can specify
--   for this parameter is 1, and the maximum is 1,000, which is also the
--   default. When the number of shards to be listed is greater than the
--   value of <tt>MaxResults</tt> , the response contains a
--   <tt>NextToken</tt> value that you can use in a subsequent call to
--   <tt>ListShards</tt> to list the next set of shards.</li>
--   </ul>
listShards :: ListShards

-- | <i>See:</i> <a>listShards</a> smart constructor.
data ListShards

-- | When the number of shards in the data stream is greater than the
--   default value for the <tt>MaxResults</tt> parameter, or if you
--   explicitly specify a value for <tt>MaxResults</tt> that is less than
--   the number of shards in the data stream, the response includes a
--   pagination token named <tt>NextToken</tt> . You can specify this
--   <tt>NextToken</tt> value in a subsequent call to <tt>ListShards</tt>
--   to list the next set of shards. Don't specify <tt>StreamName</tt> or
--   <tt>StreamCreationTimestamp</tt> if you specify <tt>NextToken</tt>
--   because the latter unambiguously identifies the stream. You can
--   optionally specify a value for the <tt>MaxResults</tt> parameter when
--   you specify <tt>NextToken</tt> . If you specify a <tt>MaxResults</tt>
--   value that is less than the number of shards that the operation
--   returns if you don't specify <tt>MaxResults</tt> , the response will
--   contain a new <tt>NextToken</tt> value. You can use the new
--   <tt>NextToken</tt> value in a subsequent call to the
--   <tt>ListShards</tt> operation. <i>Important:</i> Tokens expire after
--   300 seconds. When you obtain a value for <tt>NextToken</tt> in the
--   response to a call to <tt>ListShards</tt> , you have 300 seconds to
--   use that value. If you specify an expired token in a call to
--   <tt>ListShards</tt> , you get <tt>ExpiredNextTokenException</tt> .
lsNextToken :: Lens' ListShards (Maybe Text)

-- | The ID of the shard to start the list with. If you don't specify this
--   parameter, the default behavior is for <tt>ListShards</tt> to list the
--   shards starting with the first one in the stream. You cannot specify
--   this parameter if you specify <tt>NextToken</tt> .
lsExclusiveStartShardId :: Lens' ListShards (Maybe Text)

-- | 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 <tt>NextToken</tt> parameter.
lsStreamCreationTimestamp :: Lens' ListShards (Maybe UTCTime)

-- | The name of the data stream whose shards you want to list. You cannot
--   specify this parameter if you specify the <tt>NextToken</tt>
--   parameter.
lsStreamName :: Lens' ListShards (Maybe Text)

-- | The maximum number of shards to return in a single call to
--   <tt>ListShards</tt> . The minimum value you can specify for this
--   parameter is 1, and the maximum is 1,000, which is also the default.
--   When the number of shards to be listed is greater than the value of
--   <tt>MaxResults</tt> , the response contains a <tt>NextToken</tt> value
--   that you can use in a subsequent call to <tt>ListShards</tt> to list
--   the next set of shards.
lsMaxResults :: Lens' ListShards (Maybe Natural)

-- | Creates a value of <a>ListShardsResponse</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>lrsNextToken</a> - When the number of shards in the data stream
--   is greater than the default value for the <tt>MaxResults</tt>
--   parameter, or if you explicitly specify a value for
--   <tt>MaxResults</tt> that is less than the number of shards in the data
--   stream, the response includes a pagination token named
--   <tt>NextToken</tt> . You can specify this <tt>NextToken</tt> value in
--   a subsequent call to <tt>ListShards</tt> to list the next set of
--   shards. For more information about the use of this pagination token
--   when calling the <tt>ListShards</tt> operation, see
--   'ListShardsInput$NextToken' . <i>Important:</i> Tokens expire after
--   300 seconds. When you obtain a value for <tt>NextToken</tt> in the
--   response to a call to <tt>ListShards</tt> , you have 300 seconds to
--   use that value. If you specify an expired token in a call to
--   <tt>ListShards</tt> , you get <tt>ExpiredNextTokenException</tt>
--   .</li>
--   <li><a>lrsShards</a> - 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.</li>
--   <li><a>lrsResponseStatus</a> - -- | The response status code.</li>
--   </ul>
listShardsResponse :: Int -> ListShardsResponse

-- | <i>See:</i> <a>listShardsResponse</a> smart constructor.
data ListShardsResponse

-- | When the number of shards in the data stream is greater than the
--   default value for the <tt>MaxResults</tt> parameter, or if you
--   explicitly specify a value for <tt>MaxResults</tt> that is less than
--   the number of shards in the data stream, the response includes a
--   pagination token named <tt>NextToken</tt> . You can specify this
--   <tt>NextToken</tt> value in a subsequent call to <tt>ListShards</tt>
--   to list the next set of shards. For more information about the use of
--   this pagination token when calling the <tt>ListShards</tt> operation,
--   see 'ListShardsInput$NextToken' . <i>Important:</i> Tokens expire
--   after 300 seconds. When you obtain a value for <tt>NextToken</tt> in
--   the response to a call to <tt>ListShards</tt> , you have 300 seconds
--   to use that value. If you specify an expired token in a call to
--   <tt>ListShards</tt> , you get <tt>ExpiredNextTokenException</tt> .
lrsNextToken :: Lens' ListShardsResponse (Maybe Text)

-- | 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.
lrsShards :: Lens' ListShardsResponse [Shard]

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
lrsResponseStatus :: Lens' ListShardsResponse Int
instance GHC.Generics.Generic Network.AWS.Kinesis.ListShards.ListShardsResponse
instance Data.Data.Data Network.AWS.Kinesis.ListShards.ListShardsResponse
instance GHC.Show.Show Network.AWS.Kinesis.ListShards.ListShardsResponse
instance GHC.Read.Read Network.AWS.Kinesis.ListShards.ListShardsResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.ListShards.ListShardsResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.ListShards.ListShards
instance Data.Data.Data Network.AWS.Kinesis.ListShards.ListShards
instance GHC.Show.Show Network.AWS.Kinesis.ListShards.ListShards
instance GHC.Read.Read Network.AWS.Kinesis.ListShards.ListShards
instance GHC.Classes.Eq Network.AWS.Kinesis.ListShards.ListShards
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.ListShards.ListShards
instance Control.DeepSeq.NFData Network.AWS.Kinesis.ListShards.ListShardsResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.ListShards.ListShards
instance Control.DeepSeq.NFData Network.AWS.Kinesis.ListShards.ListShards
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.ListShards.ListShards
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.ListShards.ListShards
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.ListShards.ListShards
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.ListShards.ListShards


-- | Increases the Kinesis data stream's retention period, which is the
--   length of time data records are accessible after they are added to the
--   stream. The maximum value of a stream's retention period is 168 hours
--   (7 days).
--   
--   If you choose a longer stream retention period, this operation
--   increases the time period during which records that have not yet
--   expired are accessible. However, it does not make previous, expired
--   data (older than the stream's previous retention period) accessible
--   after the operation has been called. For example, if a stream's
--   retention period is set to 24 hours and is increased to 168 hours, any
--   data that is older than 24 hours remains inaccessible to consumer
--   applications.
module Network.AWS.Kinesis.IncreaseStreamRetentionPeriod

-- | Creates a value of <a>IncreaseStreamRetentionPeriod</a> with the
--   minimum fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>isrpStreamName</a> - The name of the stream to modify.</li>
--   <li><a>isrpRetentionPeriodHours</a> - The new retention period of the
--   stream, in hours. Must be more than the current retention period.</li>
--   </ul>
increaseStreamRetentionPeriod :: Text -> Natural -> IncreaseStreamRetentionPeriod

-- | Represents the input for <a>IncreaseStreamRetentionPeriod</a> .
--   
--   <i>See:</i> <a>increaseStreamRetentionPeriod</a> smart constructor.
data IncreaseStreamRetentionPeriod

-- | The name of the stream to modify.
isrpStreamName :: Lens' IncreaseStreamRetentionPeriod Text

-- | The new retention period of the stream, in hours. Must be more than
--   the current retention period.
isrpRetentionPeriodHours :: Lens' IncreaseStreamRetentionPeriod Natural

-- | Creates a value of <a>IncreaseStreamRetentionPeriodResponse</a> with
--   the minimum fields required to make a request.
increaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse

-- | <i>See:</i> <a>increaseStreamRetentionPeriodResponse</a> smart
--   constructor.
data IncreaseStreamRetentionPeriodResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriodResponse
instance Data.Data.Data Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriodResponse
instance GHC.Show.Show Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriodResponse
instance GHC.Read.Read Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriodResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriodResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Data.Data.Data Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance GHC.Show.Show Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance GHC.Read.Read Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance GHC.Classes.Eq Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Control.DeepSeq.NFData Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriodResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Control.DeepSeq.NFData Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.IncreaseStreamRetentionPeriod.IncreaseStreamRetentionPeriod


-- | Gets an Amazon Kinesis shard iterator. A shard iterator expires five
--   minutes after it is returned to the requester.
--   
--   A shard iterator specifies the shard position from which to start
--   reading data records sequentially. The position is specified using the
--   sequence number of a data record in a shard. A sequence number is the
--   identifier associated with every record ingested in the stream, and is
--   assigned when a record is put into the stream. Each stream has one or
--   more shards.
--   
--   You must specify the shard iterator type. For example, you can set the
--   <tt>ShardIteratorType</tt> parameter to read exactly from the position
--   denoted by a specific sequence number by using the
--   <tt>AT_SEQUENCE_NUMBER</tt> shard iterator type. Alternatively, the
--   parameter can read right after the sequence number by using the
--   <tt>AFTER_SEQUENCE_NUMBER</tt> shard iterator type, using sequence
--   numbers returned by earlier calls to <tt>PutRecord</tt> ,
--   <tt>PutRecords</tt> , <tt>GetRecords</tt> , or <tt>DescribeStream</tt>
--   . In the request, you can specify the shard iterator type
--   <tt>AT_TIMESTAMP</tt> to read records from an arbitrary point in time,
--   <tt>TRIM_HORIZON</tt> to cause <tt>ShardIterator</tt> to point to the
--   last untrimmed record in the shard in the system (the oldest data
--   record in the shard), or <tt>LATEST</tt> so that you always read the
--   most recent data in the shard.
--   
--   When you read repeatedly from a stream, use a <a>GetShardIterator</a>
--   request to get the first shard iterator for use in your first
--   <tt>GetRecords</tt> request and for subsequent reads use the shard
--   iterator returned by the <tt>GetRecords</tt> request in
--   <tt>NextShardIterator</tt> . A new shard iterator is returned by every
--   <tt>GetRecords</tt> request in <tt>NextShardIterator</tt> , which you
--   use in the <tt>ShardIterator</tt> parameter of the next
--   <tt>GetRecords</tt> request.
--   
--   If a <a>GetShardIterator</a> request is made too often, you receive a
--   <tt>ProvisionedThroughputExceededException</tt> . For more information
--   about throughput limits, see <tt>GetRecords</tt> , and <a>Streams
--   Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i> .
--   
--   If the shard is closed, <a>GetShardIterator</a> returns a valid
--   iterator for the last sequence number of the shard. A shard can be
--   closed as a result of using <tt>SplitShard</tt> or
--   <tt>MergeShards</tt> .
--   
--   <a>GetShardIterator</a> has a limit of five transactions per second
--   per account per open shard.
module Network.AWS.Kinesis.GetShardIterator

-- | Creates a value of <a>GetShardIterator</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>gsiStartingSequenceNumber</a> - 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.</li>
--   <li><a>gsiTimestamp</a> - 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, <tt>2016-04-04T19:58:46.480-00:00</tt> or
--   <tt>1459799926.480</tt> . 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).</li>
--   <li><a>gsiStreamName</a> - The name of the Amazon Kinesis data
--   stream.</li>
--   <li><a>gsiShardId</a> - The shard ID of the Kinesis Data Streams shard
--   to get the iterator for.</li>
--   <li><a>gsiShardIteratorType</a> - 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 <tt>StartingSequenceNumber</tt> . *
--   AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted
--   by a specific sequence number, provided in the value
--   <tt>StartingSequenceNumber</tt> . * AT_TIMESTAMP - Start reading from
--   the position denoted by a specific time stamp, provided in the value
--   <tt>Timestamp</tt> . * 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.</li>
--   </ul>
getShardIterator :: Text -> Text -> ShardIteratorType -> GetShardIterator

-- | Represents the input for <tt>GetShardIterator</tt> .
--   
--   <i>See:</i> <a>getShardIterator</a> smart constructor.
data GetShardIterator

-- | 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.
gsiStartingSequenceNumber :: Lens' GetShardIterator (Maybe Text)

-- | 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,
--   <tt>2016-04-04T19:58:46.480-00:00</tt> or <tt>1459799926.480</tt> . 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).
gsiTimestamp :: Lens' GetShardIterator (Maybe UTCTime)

-- | The name of the Amazon Kinesis data stream.
gsiStreamName :: Lens' GetShardIterator Text

-- | The shard ID of the Kinesis Data Streams shard to get the iterator
--   for.
gsiShardId :: Lens' GetShardIterator Text

-- | 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
--   <tt>StartingSequenceNumber</tt> . * AFTER_SEQUENCE_NUMBER - Start
--   reading right after the position denoted by a specific sequence
--   number, provided in the value <tt>StartingSequenceNumber</tt> . *
--   AT_TIMESTAMP - Start reading from the position denoted by a specific
--   time stamp, provided in the value <tt>Timestamp</tt> . * 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.
gsiShardIteratorType :: Lens' GetShardIterator ShardIteratorType

-- | Creates a value of <a>GetShardIteratorResponse</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>gsirsShardIterator</a> - 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.</li>
--   <li><a>gsirsResponseStatus</a> - -- | The response status code.</li>
--   </ul>
getShardIteratorResponse :: Int -> GetShardIteratorResponse

-- | Represents the output for <tt>GetShardIterator</tt> .
--   
--   <i>See:</i> <a>getShardIteratorResponse</a> smart constructor.
data GetShardIteratorResponse

-- | 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.
gsirsShardIterator :: Lens' GetShardIteratorResponse (Maybe Text)

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
gsirsResponseStatus :: Lens' GetShardIteratorResponse Int
instance GHC.Generics.Generic Network.AWS.Kinesis.GetShardIterator.GetShardIteratorResponse
instance Data.Data.Data Network.AWS.Kinesis.GetShardIterator.GetShardIteratorResponse
instance GHC.Show.Show Network.AWS.Kinesis.GetShardIterator.GetShardIteratorResponse
instance GHC.Read.Read Network.AWS.Kinesis.GetShardIterator.GetShardIteratorResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.GetShardIterator.GetShardIteratorResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Data.Data.Data Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance GHC.Show.Show Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance GHC.Read.Read Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance GHC.Classes.Eq Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Control.DeepSeq.NFData Network.AWS.Kinesis.GetShardIterator.GetShardIteratorResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Control.DeepSeq.NFData Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.GetShardIterator.GetShardIterator
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.GetShardIterator.GetShardIterator


-- | Gets data records from a Kinesis data stream's shard.
--   
--   Specify a shard iterator using the <tt>ShardIterator</tt> parameter.
--   The shard iterator specifies the position in the shard from which you
--   want to start reading data records sequentially. If there are no
--   records available in the portion of the shard that the iterator points
--   to, <a>GetRecords</a> returns an empty list. It might take multiple
--   calls to get to a portion of the shard that contains records.
--   
--   You can scale by provisioning multiple shards per stream while
--   considering service limits (for more information, see <a>Amazon
--   Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams
--   Developer Guide</i> ). Your application should have one thread per
--   shard, each reading continuously from its stream. To read from a
--   stream continually, call <a>GetRecords</a> in a loop. Use
--   <tt>GetShardIterator</tt> to get the shard iterator to specify in the
--   first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard
--   iterator in <tt>NextShardIterator</tt> . Specify the shard iterator
--   returned in <tt>NextShardIterator</tt> in subsequent calls to
--   <a>GetRecords</a> . If the shard has been closed, the shard iterator
--   can't return more data and <a>GetRecords</a> returns <tt>null</tt> in
--   <tt>NextShardIterator</tt> . You can terminate the loop when the shard
--   is closed, or when the shard iterator reaches the record with the
--   sequence number or other attribute that marks it as the last record to
--   process.
--   
--   Each data record can be up to 1 MB in size, and each shard can read up
--   to 2 MB per second. You can ensure that your calls don't exceed the
--   maximum supported size or throughput by using the <tt>Limit</tt>
--   parameter to specify the maximum number of records that
--   <a>GetRecords</a> can return. Consider your average record size when
--   determining this limit.
--   
--   The size of the data returned by <a>GetRecords</a> varies depending on
--   the utilization of the shard. The maximum size of data that
--   <a>GetRecords</a> can return is 10 MB. If a call returns this amount
--   of data, subsequent calls made within the next five seconds throw
--   <tt>ProvisionedThroughputExceededException</tt> . If there is
--   insufficient provisioned throughput on the stream, subsequent calls
--   made within the next one second throw
--   <tt>ProvisionedThroughputExceededException</tt> . <a>GetRecords</a>
--   won't return any data when it throws an exception. For this reason, we
--   recommend that you wait one second between calls to <a>GetRecords</a>
--   ; however, it's possible that the application will get exceptions for
--   longer than 1 second.
--   
--   To detect whether the application is falling behind in processing, you
--   can use the <tt>MillisBehindLatest</tt> response attribute. You can
--   also monitor the stream using CloudWatch metrics and other mechanisms
--   (see <a>Monitoring</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> ).
--   
--   Each Amazon Kinesis record includes a value,
--   <tt>ApproximateArrivalTimestamp</tt> , that is set when a stream
--   successfully receives and stores a record. This is commonly referred
--   to as a server-side time stamp, whereas a client-side time stamp is
--   set when a data producer creates or sends the record to a stream (a
--   data producer is any data source putting data records into a stream,
--   for example with <tt>PutRecords</tt> ). The time stamp has millisecond
--   precision. There are no guarantees about the time stamp accuracy, or
--   that the time stamp is always increasing. For example, records in a
--   shard or across a stream might have time stamps that are out of order.
module Network.AWS.Kinesis.GetRecords

-- | Creates a value of <a>GetRecords</a> with the minimum fields required
--   to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>grLimit</a> - 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, <a>GetRecords</a> throws <tt>InvalidArgumentException</tt>
--   .</li>
--   <li><a>grShardIterator</a> - 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.</li>
--   </ul>
getRecords :: Text -> GetRecords

-- | Represents the input for <a>GetRecords</a> .
--   
--   <i>See:</i> <a>getRecords</a> smart constructor.
data GetRecords

-- | 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,
--   <a>GetRecords</a> throws <tt>InvalidArgumentException</tt> .
grLimit :: Lens' GetRecords (Maybe Natural)

-- | 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.
grShardIterator :: Lens' GetRecords Text

-- | Creates a value of <a>GetRecordsResponse</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>grrsNextShardIterator</a> - The next position in the shard from
--   which to start sequentially reading data records. If set to
--   <tt>null</tt> , the shard has been closed and the requested iterator
--   does not return any more data.</li>
--   <li><a>grrsMillisBehindLatest</a> - The number of milliseconds the
--   <a>GetRecords</a> 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.</li>
--   <li><a>grrsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>grrsRecords</a> - The data records retrieved from the
--   shard.</li>
--   </ul>
getRecordsResponse :: Int -> GetRecordsResponse

-- | Represents the output for <a>GetRecords</a> .
--   
--   <i>See:</i> <a>getRecordsResponse</a> smart constructor.
data GetRecordsResponse

-- | The next position in the shard from which to start sequentially
--   reading data records. If set to <tt>null</tt> , the shard has been
--   closed and the requested iterator does not return any more data.
grrsNextShardIterator :: Lens' GetRecordsResponse (Maybe Text)

-- | The number of milliseconds the <a>GetRecords</a> 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.
grrsMillisBehindLatest :: Lens' GetRecordsResponse (Maybe Natural)

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
grrsResponseStatus :: Lens' GetRecordsResponse Int

-- | The data records retrieved from the shard.
grrsRecords :: Lens' GetRecordsResponse [Record]
instance GHC.Generics.Generic Network.AWS.Kinesis.GetRecords.GetRecordsResponse
instance Data.Data.Data Network.AWS.Kinesis.GetRecords.GetRecordsResponse
instance GHC.Show.Show Network.AWS.Kinesis.GetRecords.GetRecordsResponse
instance GHC.Read.Read Network.AWS.Kinesis.GetRecords.GetRecordsResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.GetRecords.GetRecordsResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.GetRecords.GetRecords
instance Data.Data.Data Network.AWS.Kinesis.GetRecords.GetRecords
instance GHC.Show.Show Network.AWS.Kinesis.GetRecords.GetRecords
instance GHC.Read.Read Network.AWS.Kinesis.GetRecords.GetRecords
instance GHC.Classes.Eq Network.AWS.Kinesis.GetRecords.GetRecords
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.GetRecords.GetRecords
instance Control.DeepSeq.NFData Network.AWS.Kinesis.GetRecords.GetRecordsResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.GetRecords.GetRecords
instance Control.DeepSeq.NFData Network.AWS.Kinesis.GetRecords.GetRecords
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.GetRecords.GetRecords
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.GetRecords.GetRecords
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.GetRecords.GetRecords
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.GetRecords.GetRecords


-- | Enables enhanced Kinesis data stream monitoring for shard-level
--   metrics.
module Network.AWS.Kinesis.EnableEnhancedMonitoring

-- | Creates a value of <a>EnableEnhancedMonitoring</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>eemStreamName</a> - The name of the stream for which to enable
--   enhanced monitoring.</li>
--   <li><a>eemShardLevelMetrics</a> - List of shard-level metrics to
--   enable. The following are the valid shard-level metrics. The value
--   "<tt>ALL</tt> " enables every metric. * <tt>IncomingBytes</tt> *
--   <tt>IncomingRecords</tt> * <tt>OutgoingBytes</tt> *
--   <tt>OutgoingRecords</tt> * <tt>WriteProvisionedThroughputExceeded</tt>
--   * <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .</li>
--   </ul>
enableEnhancedMonitoring :: Text -> EnableEnhancedMonitoring

-- | Represents the input for <a>EnableEnhancedMonitoring</a> .
--   
--   <i>See:</i> <a>enableEnhancedMonitoring</a> smart constructor.
data EnableEnhancedMonitoring

-- | The name of the stream for which to enable enhanced monitoring.
eemStreamName :: Lens' EnableEnhancedMonitoring Text

-- | List of shard-level metrics to enable. The following are the valid
--   shard-level metrics. The value "<tt>ALL</tt> " enables every metric. *
--   <tt>IncomingBytes</tt> * <tt>IncomingRecords</tt> *
--   <tt>OutgoingBytes</tt> * <tt>OutgoingRecords</tt> *
--   <tt>WriteProvisionedThroughputExceeded</tt> *
--   <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .
eemShardLevelMetrics :: Lens' EnableEnhancedMonitoring [MetricsName]

-- | Creates a value of <a>EnhancedMonitoringOutput</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>emoDesiredShardLevelMetrics</a> - Represents the list of all
--   the metrics that would be in the enhanced state after the
--   operation.</li>
--   <li><a>emoCurrentShardLevelMetrics</a> - Represents the current state
--   of the metrics that are in the enhanced state before the
--   operation.</li>
--   <li><a>emoStreamName</a> - The name of the Kinesis data stream.</li>
--   </ul>
enhancedMonitoringOutput :: EnhancedMonitoringOutput

-- | Represents the output for <tt>EnableEnhancedMonitoring</tt> and
--   <tt>DisableEnhancedMonitoring</tt> .
--   
--   <i>See:</i> <a>enhancedMonitoringOutput</a> smart constructor.
data EnhancedMonitoringOutput

-- | Represents the list of all the metrics that would be in the enhanced
--   state after the operation.
emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | Represents the current state of the metrics that are in the enhanced
--   state before the operation.
emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | The name of the Kinesis data stream.
emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text)
instance GHC.Generics.Generic Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Data.Data.Data Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance GHC.Show.Show Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance GHC.Read.Read Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance GHC.Classes.Eq Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Control.DeepSeq.NFData Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.EnableEnhancedMonitoring.EnableEnhancedMonitoring


-- | Disables enhanced monitoring.
module Network.AWS.Kinesis.DisableEnhancedMonitoring

-- | Creates a value of <a>DisableEnhancedMonitoring</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>demStreamName</a> - The name of the Kinesis data stream for
--   which to disable enhanced monitoring.</li>
--   <li><a>demShardLevelMetrics</a> - List of shard-level metrics to
--   disable. The following are the valid shard-level metrics. The value
--   "<tt>ALL</tt> " disables every metric. * <tt>IncomingBytes</tt> *
--   <tt>IncomingRecords</tt> * <tt>OutgoingBytes</tt> *
--   <tt>OutgoingRecords</tt> * <tt>WriteProvisionedThroughputExceeded</tt>
--   * <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .</li>
--   </ul>
disableEnhancedMonitoring :: Text -> DisableEnhancedMonitoring

-- | Represents the input for <a>DisableEnhancedMonitoring</a> .
--   
--   <i>See:</i> <a>disableEnhancedMonitoring</a> smart constructor.
data DisableEnhancedMonitoring

-- | The name of the Kinesis data stream for which to disable enhanced
--   monitoring.
demStreamName :: Lens' DisableEnhancedMonitoring Text

-- | List of shard-level metrics to disable. The following are the valid
--   shard-level metrics. The value "<tt>ALL</tt> " disables every metric.
--   * <tt>IncomingBytes</tt> * <tt>IncomingRecords</tt> *
--   <tt>OutgoingBytes</tt> * <tt>OutgoingRecords</tt> *
--   <tt>WriteProvisionedThroughputExceeded</tt> *
--   <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .
demShardLevelMetrics :: Lens' DisableEnhancedMonitoring [MetricsName]

-- | Creates a value of <a>EnhancedMonitoringOutput</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>emoDesiredShardLevelMetrics</a> - Represents the list of all
--   the metrics that would be in the enhanced state after the
--   operation.</li>
--   <li><a>emoCurrentShardLevelMetrics</a> - Represents the current state
--   of the metrics that are in the enhanced state before the
--   operation.</li>
--   <li><a>emoStreamName</a> - The name of the Kinesis data stream.</li>
--   </ul>
enhancedMonitoringOutput :: EnhancedMonitoringOutput

-- | Represents the output for <tt>EnableEnhancedMonitoring</tt> and
--   <tt>DisableEnhancedMonitoring</tt> .
--   
--   <i>See:</i> <a>enhancedMonitoringOutput</a> smart constructor.
data EnhancedMonitoringOutput

-- | Represents the list of all the metrics that would be in the enhanced
--   state after the operation.
emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | Represents the current state of the metrics that are in the enhanced
--   state before the operation.
emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | The name of the Kinesis data stream.
emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text)
instance GHC.Generics.Generic Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Data.Data.Data Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance GHC.Show.Show Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance GHC.Read.Read Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance GHC.Classes.Eq Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.DisableEnhancedMonitoring.DisableEnhancedMonitoring


-- | Provides a summarized description of the specified Kinesis data stream
--   without the shard list.
--   
--   The information returned includes the stream name, Amazon Resource
--   Name (ARN), status, record retention period, approximate creation
--   time, monitoring, encryption details, and open shard count.
module Network.AWS.Kinesis.DescribeStreamSummary

-- | Creates a value of <a>DescribeStreamSummary</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>dssStreamName</a> - The name of the stream to describe.</li>
--   </ul>
describeStreamSummary :: Text -> DescribeStreamSummary

-- | <i>See:</i> <a>describeStreamSummary</a> smart constructor.
data DescribeStreamSummary

-- | The name of the stream to describe.
dssStreamName :: Lens' DescribeStreamSummary Text

-- | Creates a value of <a>DescribeStreamSummaryResponse</a> with the
--   minimum fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>dssrsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>dssrsStreamDescriptionSummary</a> - A
--   <a>StreamDescriptionSummary</a> containing information about the
--   stream.</li>
--   </ul>
describeStreamSummaryResponse :: Int -> StreamDescriptionSummary -> DescribeStreamSummaryResponse

-- | <i>See:</i> <a>describeStreamSummaryResponse</a> smart constructor.
data DescribeStreamSummaryResponse

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
dssrsResponseStatus :: Lens' DescribeStreamSummaryResponse Int

-- | A <a>StreamDescriptionSummary</a> containing information about the
--   stream.
dssrsStreamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary
instance GHC.Generics.Generic Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummaryResponse
instance Data.Data.Data Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummaryResponse
instance GHC.Show.Show Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummaryResponse
instance GHC.Read.Read Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummaryResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummaryResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Data.Data.Data Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance GHC.Show.Show Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance GHC.Read.Read Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance GHC.Classes.Eq Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummaryResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.DescribeStreamSummary.DescribeStreamSummary


-- | Describes the specified Kinesis data stream.
--   
--   The information returned includes the stream name, Amazon Resource
--   Name (ARN), creation time, enhanced metric configuration, and shard
--   map. The shard map is an array of shard objects. For each shard
--   object, there is the hash key and sequence number ranges that the
--   shard spans, and the IDs of any earlier shards that played in a role
--   in creating the shard. Every record ingested in the stream is
--   identified by a sequence number, which is assigned when the record is
--   put into the stream.
--   
--   You can limit the number of shards returned by each call. For more
--   information, see <a>Retrieving Shards from a Stream</a> in the
--   <i>Amazon Kinesis Data Streams Developer Guide</i> .
--   
--   There are no guarantees about the chronological order shards returned.
--   To process shards in chronological order, use the ID of the parent
--   shard to track the lineage to the oldest shard.
--   
--   This operation has a limit of 10 transactions per second per account.
--   
--   This operation returns paginated results.
module Network.AWS.Kinesis.DescribeStream

-- | Creates a value of <a>DescribeStream</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>dExclusiveStartShardId</a> - The shard ID of the shard to start
--   with.</li>
--   <li><a>dLimit</a> - 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 shards are returned.</li>
--   <li><a>dStreamName</a> - The name of the stream to describe.</li>
--   </ul>
describeStream :: Text -> DescribeStream

-- | Represents the input for <tt>DescribeStream</tt> .
--   
--   <i>See:</i> <a>describeStream</a> smart constructor.
data DescribeStream

-- | The shard ID of the shard to start with.
dExclusiveStartShardId :: Lens' DescribeStream (Maybe Text)

-- | 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
--   shards are returned.
dLimit :: Lens' DescribeStream (Maybe Natural)

-- | The name of the stream to describe.
dStreamName :: Lens' DescribeStream Text

-- | Creates a value of <a>DescribeStreamResponse</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>dsrsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>dsrsStreamDescription</a> - 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.</li>
--   </ul>
describeStreamResponse :: Int -> StreamDescription -> DescribeStreamResponse

-- | Represents the output for <tt>DescribeStream</tt> .
--   
--   <i>See:</i> <a>describeStreamResponse</a> smart constructor.
data DescribeStreamResponse

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
dsrsResponseStatus :: Lens' DescribeStreamResponse Int

-- | 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.
dsrsStreamDescription :: Lens' DescribeStreamResponse StreamDescription
instance GHC.Generics.Generic Network.AWS.Kinesis.DescribeStream.DescribeStreamResponse
instance Data.Data.Data Network.AWS.Kinesis.DescribeStream.DescribeStreamResponse
instance GHC.Show.Show Network.AWS.Kinesis.DescribeStream.DescribeStreamResponse
instance GHC.Read.Read Network.AWS.Kinesis.DescribeStream.DescribeStreamResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.DescribeStream.DescribeStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Data.Data.Data Network.AWS.Kinesis.DescribeStream.DescribeStream
instance GHC.Show.Show Network.AWS.Kinesis.DescribeStream.DescribeStream
instance GHC.Read.Read Network.AWS.Kinesis.DescribeStream.DescribeStream
instance GHC.Classes.Eq Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DescribeStream.DescribeStreamResponse
instance Network.AWS.Pager.AWSPager Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.DescribeStream.DescribeStream
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.DescribeStream.DescribeStream


-- | Describes the shard limits and usage for the account.
--   
--   If you update your account limits, the old limits might be returned
--   for a few minutes.
--   
--   This operation has a limit of one transaction per second per account.
module Network.AWS.Kinesis.DescribeLimits

-- | Creates a value of <a>DescribeLimits</a> with the minimum fields
--   required to make a request.
describeLimits :: DescribeLimits

-- | <i>See:</i> <a>describeLimits</a> smart constructor.
data DescribeLimits

-- | Creates a value of <a>DescribeLimitsResponse</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>dlrsResponseStatus</a> - -- | The response status code.</li>
--   <li><a>dlrsShardLimit</a> - The maximum number of shards.</li>
--   <li><a>dlrsOpenShardCount</a> - The number of open shards.</li>
--   </ul>
describeLimitsResponse :: Int -> Natural -> Natural -> DescribeLimitsResponse

-- | <i>See:</i> <a>describeLimitsResponse</a> smart constructor.
data DescribeLimitsResponse

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
dlrsResponseStatus :: Lens' DescribeLimitsResponse Int

-- | The maximum number of shards.
dlrsShardLimit :: Lens' DescribeLimitsResponse Natural

-- | The number of open shards.
dlrsOpenShardCount :: Lens' DescribeLimitsResponse Natural
instance GHC.Generics.Generic Network.AWS.Kinesis.DescribeLimits.DescribeLimitsResponse
instance Data.Data.Data Network.AWS.Kinesis.DescribeLimits.DescribeLimitsResponse
instance GHC.Show.Show Network.AWS.Kinesis.DescribeLimits.DescribeLimitsResponse
instance GHC.Read.Read Network.AWS.Kinesis.DescribeLimits.DescribeLimitsResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.DescribeLimits.DescribeLimitsResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Data.Data.Data Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance GHC.Show.Show Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance GHC.Read.Read Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance GHC.Classes.Eq Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DescribeLimits.DescribeLimitsResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.DescribeLimits.DescribeLimits
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.DescribeLimits.DescribeLimits


-- | Deletes a Kinesis data stream and all its shards and data. You must
--   shut down any applications that are operating on the stream before you
--   delete the stream. If an application attempts to operate on a deleted
--   stream, it receives the exception <tt>ResourceNotFoundException</tt> .
--   
--   If the stream is in the <tt>ACTIVE</tt> state, you can delete it.
--   After a <tt>DeleteStream</tt> request, the specified stream is in the
--   <tt>DELETING</tt> state until Kinesis Data Streams completes the
--   deletion.
--   
--   <b>Note:</b> Kinesis Data Streams might continue to accept data read
--   and write operations, such as <tt>PutRecord</tt> , <tt>PutRecords</tt>
--   , and <tt>GetRecords</tt> , on a stream in the <tt>DELETING</tt> state
--   until the stream deletion is complete.
--   
--   When you delete a stream, any shards in that stream are also deleted,
--   and any tags are dissociated from the stream.
--   
--   You can use the <tt>DescribeStream</tt> operation to check the state
--   of the stream, which is returned in <tt>StreamStatus</tt> .
--   
--   <a>DeleteStream</a> has a limit of five transactions per second per
--   account.
module Network.AWS.Kinesis.DeleteStream

-- | Creates a value of <a>DeleteStream</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>dsStreamName</a> - The name of the stream to delete.</li>
--   </ul>
deleteStream :: Text -> DeleteStream

-- | Represents the input for <a>DeleteStream</a> .
--   
--   <i>See:</i> <a>deleteStream</a> smart constructor.
data DeleteStream

-- | The name of the stream to delete.
dsStreamName :: Lens' DeleteStream Text

-- | Creates a value of <a>DeleteStreamResponse</a> with the minimum fields
--   required to make a request.
deleteStreamResponse :: DeleteStreamResponse

-- | <i>See:</i> <a>deleteStreamResponse</a> smart constructor.
data DeleteStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.DeleteStream.DeleteStreamResponse
instance Data.Data.Data Network.AWS.Kinesis.DeleteStream.DeleteStreamResponse
instance GHC.Show.Show Network.AWS.Kinesis.DeleteStream.DeleteStreamResponse
instance GHC.Read.Read Network.AWS.Kinesis.DeleteStream.DeleteStreamResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.DeleteStream.DeleteStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Data.Data.Data Network.AWS.Kinesis.DeleteStream.DeleteStream
instance GHC.Show.Show Network.AWS.Kinesis.DeleteStream.DeleteStream
instance GHC.Read.Read Network.AWS.Kinesis.DeleteStream.DeleteStream
instance GHC.Classes.Eq Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DeleteStream.DeleteStreamResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.DeleteStream.DeleteStream
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.DeleteStream.DeleteStream


-- | Decreases the Kinesis data stream's retention period, which is the
--   length of time data records are accessible after they are added to the
--   stream. The minimum value of a stream's retention period is 24 hours.
--   
--   This operation may result in lost data. For example, if the stream's
--   retention period is 48 hours and is decreased to 24 hours, any data
--   already in the stream that is older than 24 hours is inaccessible.
module Network.AWS.Kinesis.DecreaseStreamRetentionPeriod

-- | Creates a value of <a>DecreaseStreamRetentionPeriod</a> with the
--   minimum fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>dsrpStreamName</a> - The name of the stream to modify.</li>
--   <li><a>dsrpRetentionPeriodHours</a> - The new retention period of the
--   stream, in hours. Must be less than the current retention period.</li>
--   </ul>
decreaseStreamRetentionPeriod :: Text -> Natural -> DecreaseStreamRetentionPeriod

-- | Represents the input for <a>DecreaseStreamRetentionPeriod</a> .
--   
--   <i>See:</i> <a>decreaseStreamRetentionPeriod</a> smart constructor.
data DecreaseStreamRetentionPeriod

-- | The name of the stream to modify.
dsrpStreamName :: Lens' DecreaseStreamRetentionPeriod Text

-- | The new retention period of the stream, in hours. Must be less than
--   the current retention period.
dsrpRetentionPeriodHours :: Lens' DecreaseStreamRetentionPeriod Natural

-- | Creates a value of <a>DecreaseStreamRetentionPeriodResponse</a> with
--   the minimum fields required to make a request.
decreaseStreamRetentionPeriodResponse :: DecreaseStreamRetentionPeriodResponse

-- | <i>See:</i> <a>decreaseStreamRetentionPeriodResponse</a> smart
--   constructor.
data DecreaseStreamRetentionPeriodResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriodResponse
instance Data.Data.Data Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriodResponse
instance GHC.Show.Show Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriodResponse
instance GHC.Read.Read Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriodResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriodResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Data.Data.Data Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance GHC.Show.Show Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance GHC.Read.Read Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance GHC.Classes.Eq Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriodResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Control.DeepSeq.NFData Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.DecreaseStreamRetentionPeriod.DecreaseStreamRetentionPeriod


-- | Creates a Kinesis data stream. A stream captures and transports data
--   records that are continuously emitted from different data sources or
--   <i>producers</i> . Scale-out within a stream is explicitly supported
--   by means of shards, which are uniquely identified groups of data
--   records in a stream.
--   
--   You specify and control the number of shards that a stream is composed
--   of. Each shard can support reads up to five transactions per second,
--   up to a maximum data read total of 2 MB per second. Each shard can
--   support writes up to 1,000 records per second, up to a maximum data
--   write total of 1 MB per second. If the amount of data input increases
--   or decreases, you can add or remove shards.
--   
--   The stream name identifies the stream. The name is scoped to the AWS
--   account used by the application. It is also scoped by AWS Region. That
--   is, two streams in two different accounts can have the same name, and
--   two streams in the same account, but in two different Regions, can
--   have the same name.
--   
--   <tt>CreateStream</tt> is an asynchronous operation. Upon receiving a
--   <tt>CreateStream</tt> request, Kinesis Data Streams immediately
--   returns and sets the stream status to <tt>CREATING</tt> . After the
--   stream is created, Kinesis Data Streams sets the stream status to
--   <tt>ACTIVE</tt> . You should perform read and write operations only on
--   an <tt>ACTIVE</tt> stream.
--   
--   You receive a <tt>LimitExceededException</tt> when making a
--   <tt>CreateStream</tt> request when you try to do one of the following:
--   
--   <ul>
--   <li>Have more than five streams in the <tt>CREATING</tt> state at any
--   point in time.</li>
--   <li>Create more shards than are authorized for your account.</li>
--   </ul>
--   
--   For the default shard limit for an AWS account, see <a>Amazon Kinesis
--   Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams
--   Developer Guide</i> . To increase this limit, <a>contact AWS
--   Support</a> .
--   
--   You can use <tt>DescribeStream</tt> to check the stream status, which
--   is returned in <tt>StreamStatus</tt> .
--   
--   <a>CreateStream</a> has a limit of five transactions per second per
--   account.
module Network.AWS.Kinesis.CreateStream

-- | Creates a value of <a>CreateStream</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>csStreamName</a> - A name to identify the stream. The stream
--   name is scoped to the AWS account used by the application that creates
--   the stream. It is also scoped by AWS Region. That is, two streams in
--   two different AWS accounts can have the same name. Two streams in the
--   same AWS account but in two different Regions can also have the same
--   name.</li>
--   <li><a>csShardCount</a> - 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.
--   DefaultShardLimit;</li>
--   </ul>
createStream :: Text -> Natural -> CreateStream

-- | Represents the input for <tt>CreateStream</tt> .
--   
--   <i>See:</i> <a>createStream</a> smart constructor.
data CreateStream

-- | A name to identify the stream. The stream name is scoped to the AWS
--   account used by the application that creates the stream. It is also
--   scoped by AWS Region. That is, two streams in two different AWS
--   accounts can have the same name. Two streams in the same AWS account
--   but in two different Regions can also have the same name.
csStreamName :: Lens' CreateStream Text

-- | 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. DefaultShardLimit;
csShardCount :: Lens' CreateStream Natural

-- | Creates a value of <a>CreateStreamResponse</a> with the minimum fields
--   required to make a request.
createStreamResponse :: CreateStreamResponse

-- | <i>See:</i> <a>createStreamResponse</a> smart constructor.
data CreateStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.CreateStream.CreateStreamResponse
instance Data.Data.Data Network.AWS.Kinesis.CreateStream.CreateStreamResponse
instance GHC.Show.Show Network.AWS.Kinesis.CreateStream.CreateStreamResponse
instance GHC.Read.Read Network.AWS.Kinesis.CreateStream.CreateStreamResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.CreateStream.CreateStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.CreateStream.CreateStream
instance Data.Data.Data Network.AWS.Kinesis.CreateStream.CreateStream
instance GHC.Show.Show Network.AWS.Kinesis.CreateStream.CreateStream
instance GHC.Read.Read Network.AWS.Kinesis.CreateStream.CreateStream
instance GHC.Classes.Eq Network.AWS.Kinesis.CreateStream.CreateStream
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.CreateStream.CreateStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.CreateStream.CreateStreamResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.CreateStream.CreateStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.CreateStream.CreateStream
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.CreateStream.CreateStream
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.CreateStream.CreateStream
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.CreateStream.CreateStream
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.CreateStream.CreateStream


-- | Adds or updates tags for the specified Kinesis data stream. Each
--   stream can have up to 10 tags.
--   
--   If tags have already been assigned to the stream,
--   <tt>AddTagsToStream</tt> overwrites any existing tags that correspond
--   to the specified tag keys.
--   
--   <a>AddTagsToStream</a> has a limit of five transactions per second per
--   account.
module Network.AWS.Kinesis.AddTagsToStream

-- | Creates a value of <a>AddTagsToStream</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>attsStreamName</a> - The name of the stream.</li>
--   <li><a>attsTags</a> - The set of key-value pairs to use to create the
--   tags.</li>
--   </ul>
addTagsToStream :: Text -> AddTagsToStream

-- | Represents the input for <tt>AddTagsToStream</tt> .
--   
--   <i>See:</i> <a>addTagsToStream</a> smart constructor.
data AddTagsToStream

-- | The name of the stream.
attsStreamName :: Lens' AddTagsToStream Text

-- | The set of key-value pairs to use to create the tags.
attsTags :: Lens' AddTagsToStream (HashMap Text Text)

-- | Creates a value of <a>AddTagsToStreamResponse</a> with the minimum
--   fields required to make a request.
addTagsToStreamResponse :: AddTagsToStreamResponse

-- | <i>See:</i> <a>addTagsToStreamResponse</a> smart constructor.
data AddTagsToStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.AddTagsToStream.AddTagsToStreamResponse
instance Data.Data.Data Network.AWS.Kinesis.AddTagsToStream.AddTagsToStreamResponse
instance GHC.Show.Show Network.AWS.Kinesis.AddTagsToStream.AddTagsToStreamResponse
instance GHC.Read.Read Network.AWS.Kinesis.AddTagsToStream.AddTagsToStreamResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.AddTagsToStream.AddTagsToStreamResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Data.Data.Data Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance GHC.Show.Show Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance GHC.Read.Read Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance GHC.Classes.Eq Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.AddTagsToStream.AddTagsToStreamResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Control.DeepSeq.NFData Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.AddTagsToStream.AddTagsToStream


-- | Updates the shard count of the specified stream to the specified
--   number of shards.
--   
--   Updating the shard count is an asynchronous operation. Upon receiving
--   the request, Kinesis Data Streams returns immediately and sets the
--   status of the stream to <tt>UPDATING</tt> . After the update is
--   complete, Kinesis Data Streams sets the status of the stream back to
--   <tt>ACTIVE</tt> . Depending on the size of the stream, the scaling
--   action could take a few minutes to complete. You can continue to read
--   and write data to your stream while its status is <tt>UPDATING</tt> .
--   
--   To update the shard count, Kinesis Data Streams performs splits or
--   merges on individual shards. This can cause short-lived shards to be
--   created, in addition to the final shards. We recommend that you double
--   or halve the shard count, as this results in the fewest number of
--   splits or merges.
--   
--   This operation has the following limits. You cannot do the following:
--   
--   <ul>
--   <li>Scale more than twice per rolling 24-hour period per stream</li>
--   <li>Scale up to more than double your current shard count for a
--   stream</li>
--   <li>Scale down below half your current shard count for a stream</li>
--   <li>Scale up to more than 500 shards in a stream</li>
--   <li>Scale a stream with more than 500 shards down unless the result is
--   less than 500 shards</li>
--   <li>Scale up to more than the shard limit for your account</li>
--   </ul>
--   
--   For the default limits for an AWS account, see <a>Streams Limits</a>
--   in the <i>Amazon Kinesis Data Streams Developer Guide</i> . To request
--   an increase in the call rate limit, the shard limit for this API, or
--   your overall shard limit, use the <a>limits form</a> .
module Network.AWS.Kinesis.UpdateShardCount

-- | Creates a value of <a>UpdateShardCount</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>uscStreamName</a> - The name of the stream.</li>
--   <li><a>uscTargetShardCount</a> - The new number of shards.</li>
--   <li><a>uscScalingType</a> - The scaling type. Uniform scaling creates
--   shards of equal size.</li>
--   </ul>
updateShardCount :: Text -> Natural -> ScalingType -> UpdateShardCount

-- | <i>See:</i> <a>updateShardCount</a> smart constructor.
data UpdateShardCount

-- | The name of the stream.
uscStreamName :: Lens' UpdateShardCount Text

-- | The new number of shards.
uscTargetShardCount :: Lens' UpdateShardCount Natural

-- | The scaling type. Uniform scaling creates shards of equal size.
uscScalingType :: Lens' UpdateShardCount ScalingType

-- | Creates a value of <a>UpdateShardCountResponse</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>uscrsTargetShardCount</a> - The updated number of shards.</li>
--   <li><a>uscrsStreamName</a> - The name of the stream.</li>
--   <li><a>uscrsCurrentShardCount</a> - The current number of shards.</li>
--   <li><a>uscrsResponseStatus</a> - -- | The response status code.</li>
--   </ul>
updateShardCountResponse :: Int -> UpdateShardCountResponse

-- | <i>See:</i> <a>updateShardCountResponse</a> smart constructor.
data UpdateShardCountResponse

-- | The updated number of shards.
uscrsTargetShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)

-- | The name of the stream.
uscrsStreamName :: Lens' UpdateShardCountResponse (Maybe Text)

-- | The current number of shards.
uscrsCurrentShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)

-- | <ul>
--   <li>- | The response status code.</li>
--   </ul>
uscrsResponseStatus :: Lens' UpdateShardCountResponse Int
instance GHC.Generics.Generic Network.AWS.Kinesis.UpdateShardCount.UpdateShardCountResponse
instance Data.Data.Data Network.AWS.Kinesis.UpdateShardCount.UpdateShardCountResponse
instance GHC.Show.Show Network.AWS.Kinesis.UpdateShardCount.UpdateShardCountResponse
instance GHC.Read.Read Network.AWS.Kinesis.UpdateShardCount.UpdateShardCountResponse
instance GHC.Classes.Eq Network.AWS.Kinesis.UpdateShardCount.UpdateShardCountResponse
instance GHC.Generics.Generic Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Data.Data.Data Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance GHC.Show.Show Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance GHC.Read.Read Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance GHC.Classes.Eq Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Network.AWS.Types.AWSRequest Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Control.DeepSeq.NFData Network.AWS.Kinesis.UpdateShardCount.UpdateShardCountResponse
instance Data.Hashable.Class.Hashable Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Control.DeepSeq.NFData Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Network.AWS.Data.Path.ToPath Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount
instance Network.AWS.Data.Query.ToQuery Network.AWS.Kinesis.UpdateShardCount.UpdateShardCount


module Network.AWS.Kinesis.Waiters

-- | Polls <a>DescribeStream</a> every 10 seconds until a successful state
--   is reached. An error is returned after 18 failed checks.
streamExists :: Wait DescribeStream

-- | Polls <a>DescribeStream</a> every 10 seconds until a successful state
--   is reached. An error is returned after 18 failed checks.
streamNotExists :: Wait DescribeStream


-- | <b>Amazon Kinesis Data Streams Service API Reference</b>
--   
--   Amazon Kinesis Data Streams is a managed service that scales
--   elastically for real-time processing of streaming big data.
module Network.AWS.Kinesis

-- | API version <tt>2013-12-02</tt> of the Amazon Kinesis SDK
--   configuration.
kinesis :: Service

-- | The request was rejected because the state of the specified resource
--   isn't valid for this request. For more information, see <a>How Key
--   State Affects Use of a Customer Master Key</a> in the <i>AWS Key
--   Management Service Developer Guide</i> .
_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The request was denied due to request throttling. For more information
--   about throttling, see <a>Limits</a> in the <i>AWS Key Management
--   Service Developer Guide</i> .
_KMSThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The provided iterator exceeds the maximum age allowed.
_ExpiredIteratorException :: 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.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The AWS access key ID needs a subscription for the service.
_KMSOptInRequired :: 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 <a>Streams Limits</a> in
--   the <i>Amazon Kinesis Data Streams Developer Guide</i> , and <a>Error
--   Retries and Exponential Backoff in AWS</a> in the <i>AWS General
--   Reference</i> .
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The request was rejected because the specified entity or resource
--   can't be found.
_KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The pagination token passed to the <tt>ListShards</tt> operation is
--   expired. For more information, see 'ListShardsInput$NextToken' .
_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The request was rejected because the specified customer master key
--   (CMK) isn't enabled.
_KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The requested resource could not be found. The stream might not be
--   specified correctly.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The ciphertext references a key that doesn't exist or that you don't
--   have access to.
_KMSAccessDeniedException :: 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.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

-- | The resource is not available for this operation. For successful
--   operation, the resource must be in the <tt>ACTIVE</tt> state.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError

-- | Polls <a>DescribeStream</a> every 10 seconds until a successful state
--   is reached. An error is returned after 18 failed checks.
streamExists :: Wait DescribeStream

-- | Polls <a>DescribeStream</a> every 10 seconds until a successful state
--   is reached. An error is returned after 18 failed checks.
streamNotExists :: Wait DescribeStream
data EncryptionType
KMS :: EncryptionType
None :: EncryptionType
data MetricsName
All :: MetricsName
IncomingBytes :: MetricsName
IncomingRecords :: MetricsName
IteratorAgeMilliseconds :: MetricsName
OutgoingBytes :: MetricsName
OutgoingRecords :: MetricsName
ReadProvisionedThroughputExceeded :: MetricsName
WriteProvisionedThroughputExceeded :: MetricsName
data ScalingType
UniformScaling :: ScalingType
data ShardIteratorType
AfterSequenceNumber :: ShardIteratorType
AtSequenceNumber :: ShardIteratorType
AtTimestamp :: ShardIteratorType
Latest :: ShardIteratorType
TrimHorizon :: ShardIteratorType
data StreamStatus
Active :: StreamStatus
Creating :: StreamStatus
Deleting :: StreamStatus
Updating :: StreamStatus

-- | Represents enhanced metrics types.
--   
--   <i>See:</i> <a>enhancedMetrics</a> smart constructor.
data EnhancedMetrics

-- | Creates a value of <a>EnhancedMetrics</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>emShardLevelMetrics</a> - List of shard-level metrics. The
--   following are the valid shard-level metrics. The value "<tt>ALL</tt> "
--   enhances every metric. * <tt>IncomingBytes</tt> *
--   <tt>IncomingRecords</tt> * <tt>OutgoingBytes</tt> *
--   <tt>OutgoingRecords</tt> * <tt>WriteProvisionedThroughputExceeded</tt>
--   * <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .</li>
--   </ul>
enhancedMetrics :: EnhancedMetrics

-- | List of shard-level metrics. The following are the valid shard-level
--   metrics. The value "<tt>ALL</tt> " enhances every metric. *
--   <tt>IncomingBytes</tt> * <tt>IncomingRecords</tt> *
--   <tt>OutgoingBytes</tt> * <tt>OutgoingRecords</tt> *
--   <tt>WriteProvisionedThroughputExceeded</tt> *
--   <tt>ReadProvisionedThroughputExceeded</tt> *
--   <tt>IteratorAgeMilliseconds</tt> * <tt>ALL</tt> For more information,
--   see <a>Monitoring the Amazon Kinesis Data Streams Service with Amazon
--   CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer
--   Guide</i> .
emShardLevelMetrics :: Lens' EnhancedMetrics [MetricsName]

-- | Represents the output for <tt>EnableEnhancedMonitoring</tt> and
--   <tt>DisableEnhancedMonitoring</tt> .
--   
--   <i>See:</i> <a>enhancedMonitoringOutput</a> smart constructor.
data EnhancedMonitoringOutput

-- | Creates a value of <a>EnhancedMonitoringOutput</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>emoDesiredShardLevelMetrics</a> - Represents the list of all
--   the metrics that would be in the enhanced state after the
--   operation.</li>
--   <li><a>emoCurrentShardLevelMetrics</a> - Represents the current state
--   of the metrics that are in the enhanced state before the
--   operation.</li>
--   <li><a>emoStreamName</a> - The name of the Kinesis data stream.</li>
--   </ul>
enhancedMonitoringOutput :: EnhancedMonitoringOutput

-- | Represents the list of all the metrics that would be in the enhanced
--   state after the operation.
emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | Represents the current state of the metrics that are in the enhanced
--   state before the operation.
emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

-- | The name of the Kinesis data stream.
emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text)

-- | The range of possible hash key values for the shard, which is a set of
--   ordered contiguous positive integers.
--   
--   <i>See:</i> <a>hashKeyRange</a> smart constructor.
data HashKeyRange

-- | Creates a value of <a>HashKeyRange</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>hkrStartingHashKey</a> - The starting hash key of the hash key
--   range.</li>
--   <li><a>hkrEndingHashKey</a> - The ending hash key of the hash key
--   range.</li>
--   </ul>
hashKeyRange :: Text -> Text -> HashKeyRange

-- | The starting hash key of the hash key range.
hkrStartingHashKey :: Lens' HashKeyRange Text

-- | The ending hash key of the hash key range.
hkrEndingHashKey :: Lens' HashKeyRange Text

-- | Represents the output for <tt>PutRecords</tt> .
--   
--   <i>See:</i> <a>putRecordsRequestEntry</a> smart constructor.
data PutRecordsRequestEntry

-- | Creates a value of <a>PutRecordsRequestEntry</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>prreExplicitHashKey</a> - The hash value used to determine
--   explicitly the shard that the data record is assigned to by overriding
--   the partition key hash.</li>
--   <li><a>prreData</a> - 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).--
--   <i>Note:</i> This <tt>Lens</tt> automatically encodes and decodes
--   Base64 data. The underlying isomorphism will encode to Base64
--   representation during serialisation, and decode from Base64
--   representation during deserialisation. This <tt>Lens</tt> accepts and
--   returns only raw unencoded data.</li>
--   <li><a>prrePartitionKey</a> - 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.</li>
--   </ul>
putRecordsRequestEntry :: ByteString -> Text -> PutRecordsRequestEntry

-- | The hash value used to determine explicitly the shard that the data
--   record is assigned to by overriding the partition key hash.
prreExplicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)

-- | 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).-- <i>Note:</i> This
--   <tt>Lens</tt> automatically encodes and decodes Base64 data. The
--   underlying isomorphism will encode to Base64 representation during
--   serialisation, and decode from Base64 representation during
--   deserialisation. This <tt>Lens</tt> accepts and returns only raw
--   unencoded data.
prreData :: Lens' PutRecordsRequestEntry ByteString

-- | 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.
prrePartitionKey :: Lens' PutRecordsRequestEntry Text

-- | Represents the result of an individual record from a
--   <tt>PutRecords</tt> request. A record that is successfully added to a
--   stream includes <tt>SequenceNumber</tt> and <tt>ShardId</tt> in the
--   result. A record that fails to be added to the stream includes
--   <tt>ErrorCode</tt> and <tt>ErrorMessage</tt> in the result.
--   
--   <i>See:</i> <a>putRecordsResultEntry</a> smart constructor.
data PutRecordsResultEntry

-- | Creates a value of <a>PutRecordsResultEntry</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>prreSequenceNumber</a> - The sequence number for an individual
--   record result.</li>
--   <li><a>prreErrorCode</a> - The error code for an individual record
--   result. <tt>ErrorCodes</tt> can be either
--   <tt>ProvisionedThroughputExceededException</tt> or
--   <tt>InternalFailure</tt> .</li>
--   <li><a>prreErrorMessage</a> - The error message for an individual
--   record result. An <tt>ErrorCode</tt> value of
--   <tt>ProvisionedThroughputExceededException</tt> has an error message
--   that includes the account ID, stream name, and shard ID. An
--   <tt>ErrorCode</tt> value of <tt>InternalFailure</tt> has the error
--   message <tt>"Internal Service Failure"</tt> .</li>
--   <li><a>prreShardId</a> - The shard ID for an individual record
--   result.</li>
--   </ul>
putRecordsResultEntry :: PutRecordsResultEntry

-- | The sequence number for an individual record result.
prreSequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The error code for an individual record result. <tt>ErrorCodes</tt>
--   can be either <tt>ProvisionedThroughputExceededException</tt> or
--   <tt>InternalFailure</tt> .
prreErrorCode :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The error message for an individual record result. An
--   <tt>ErrorCode</tt> value of
--   <tt>ProvisionedThroughputExceededException</tt> has an error message
--   that includes the account ID, stream name, and shard ID. An
--   <tt>ErrorCode</tt> value of <tt>InternalFailure</tt> has the error
--   message <tt>"Internal Service Failure"</tt> .
prreErrorMessage :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The shard ID for an individual record result.
prreShardId :: Lens' PutRecordsResultEntry (Maybe Text)

-- | The unit of data of the Kinesis data stream, which is composed of a
--   sequence number, a partition key, and a data blob.
--   
--   <i>See:</i> <a>record</a> smart constructor.
data Record

-- | Creates a value of <a>Record</a> with the minimum fields required to
--   make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>rEncryptionType</a> - The encryption type used on the record.
--   This parameter can be one of the following values: * <tt>NONE</tt> :
--   Do not encrypt the records in the stream. * <tt>KMS</tt> : Use
--   server-side encryption on the records in the stream using a
--   customer-managed AWS KMS key.</li>
--   <li><a>rApproximateArrivalTimestamp</a> - The approximate time that
--   the record was inserted into the stream.</li>
--   <li><a>rSequenceNumber</a> - The unique identifier of the record
--   within its shard.</li>
--   <li><a>rData</a> - 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).-- <i>Note:</i> This <tt>Lens</tt> automatically encodes and
--   decodes Base64 data. The underlying isomorphism will encode to Base64
--   representation during serialisation, and decode from Base64
--   representation during deserialisation. This <tt>Lens</tt> accepts and
--   returns only raw unencoded data.</li>
--   <li><a>rPartitionKey</a> - Identifies which shard in the stream the
--   data record is assigned to.</li>
--   </ul>
record :: Text -> ByteString -> Text -> Record

-- | The encryption type used on the record. This parameter can be one of
--   the following values: * <tt>NONE</tt> : Do not encrypt the records in
--   the stream. * <tt>KMS</tt> : Use server-side encryption on the records
--   in the stream using a customer-managed AWS KMS key.
rEncryptionType :: Lens' Record (Maybe EncryptionType)

-- | The approximate time that the record was inserted into the stream.
rApproximateArrivalTimestamp :: Lens' Record (Maybe UTCTime)

-- | The unique identifier of the record within its shard.
rSequenceNumber :: Lens' Record Text

-- | 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).-- <i>Note:</i> This
--   <tt>Lens</tt> automatically encodes and decodes Base64 data. The
--   underlying isomorphism will encode to Base64 representation during
--   serialisation, and decode from Base64 representation during
--   deserialisation. This <tt>Lens</tt> accepts and returns only raw
--   unencoded data.
rData :: Lens' Record ByteString

-- | Identifies which shard in the stream the data record is assigned to.
rPartitionKey :: Lens' Record Text

-- | The range of possible sequence numbers for the shard.
--   
--   <i>See:</i> <a>sequenceNumberRange</a> smart constructor.
data SequenceNumberRange

-- | Creates a value of <a>SequenceNumberRange</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>snrEndingSequenceNumber</a> - The ending sequence number for
--   the range. Shards that are in the OPEN state have an ending sequence
--   number of <tt>null</tt> .</li>
--   <li><a>snrStartingSequenceNumber</a> - The starting sequence number
--   for the range.</li>
--   </ul>
sequenceNumberRange :: Text -> SequenceNumberRange

-- | The ending sequence number for the range. Shards that are in the OPEN
--   state have an ending sequence number of <tt>null</tt> .
snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)

-- | The starting sequence number for the range.
snrStartingSequenceNumber :: Lens' SequenceNumberRange Text

-- | A uniquely identified group of data records in a Kinesis data stream.
--   
--   <i>See:</i> <a>shard</a> smart constructor.
data Shard

-- | Creates a value of <a>Shard</a> with the minimum fields required to
--   make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sAdjacentParentShardId</a> - The shard ID of the shard adjacent
--   to the shard's parent.</li>
--   <li><a>sParentShardId</a> - The shard ID of the shard's parent.</li>
--   <li><a>sShardId</a> - The unique identifier of the shard within the
--   stream.</li>
--   <li><a>sHashKeyRange</a> - The range of possible hash key values for
--   the shard, which is a set of ordered contiguous positive
--   integers.</li>
--   <li><a>sSequenceNumberRange</a> - The range of possible sequence
--   numbers for the shard.</li>
--   </ul>
shard :: Text -> HashKeyRange -> SequenceNumberRange -> Shard

-- | The shard ID of the shard adjacent to the shard's parent.
sAdjacentParentShardId :: Lens' Shard (Maybe Text)

-- | The shard ID of the shard's parent.
sParentShardId :: Lens' Shard (Maybe Text)

-- | The unique identifier of the shard within the stream.
sShardId :: Lens' Shard Text

-- | The range of possible hash key values for the shard, which is a set of
--   ordered contiguous positive integers.
sHashKeyRange :: Lens' Shard HashKeyRange

-- | The range of possible sequence numbers for the shard.
sSequenceNumberRange :: Lens' Shard SequenceNumberRange

-- | Represents the output for <tt>DescribeStream</tt> .
--   
--   <i>See:</i> <a>streamDescription</a> smart constructor.
data StreamDescription

-- | Creates a value of <a>StreamDescription</a> with the minimum fields
--   required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sdEncryptionType</a> - The server-side encryption type used on
--   the stream. This parameter can be one of the following values: *
--   <tt>NONE</tt> : Do not encrypt the records in the stream. *
--   <tt>KMS</tt> : Use server-side encryption on the records in the stream
--   using a customer-managed AWS KMS key.</li>
--   <li><a>sdKeyId</a> - 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<i>".You can also use a master key owned by Kinesis
--   Data Streams by specifying the alias @aws</i>kinesis<tt> . * Key ARN
--   example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@</li>
--   <li><a>sdStreamName</a> - The name of the stream being described.</li>
--   <li><a>sdStreamARN</a> - The Amazon Resource Name (ARN) for the stream
--   being described.</li>
--   <li><a>sdStreamStatus</a> - The current status of the stream being
--   described. The stream status is one of the following states: *
--   <tt>CREATING</tt> - The stream is being created. Kinesis Data Streams
--   immediately returns and sets <tt>StreamStatus</tt> to
--   <tt>CREATING</tt> . * <tt>DELETING</tt> - The stream is being deleted.
--   The specified stream is in the <tt>DELETING</tt> state until Kinesis
--   Data Streams completes the deletion. * <tt>ACTIVE</tt> - The stream
--   exists and is ready for read and write operations or deletion. You
--   should perform read and write operations only on an <tt>ACTIVE</tt>
--   stream. * <tt>UPDATING</tt> - Shards in the stream are being merged or
--   split. Read and write operations continue to work while the stream is
--   in the <tt>UPDATING</tt> state.</li>
--   <li><a>sdShards</a> - The shards that comprise the stream.</li>
--   <li><a>sdHasMoreShards</a> - If set to <tt>true</tt> , more shards in
--   the stream are available to describe.</li>
--   <li><a>sdRetentionPeriodHours</a> - The current retention period, in
--   hours.</li>
--   <li><a>sdStreamCreationTimestamp</a> - The approximate time that the
--   stream was created.</li>
--   <li><a>sdEnhancedMonitoring</a> - Represents the current enhanced
--   monitoring settings of the stream.</li>
--   </ul>
streamDescription :: Text -> Text -> StreamStatus -> Bool -> Natural -> UTCTime -> StreamDescription

-- | The server-side encryption type used on the stream. This parameter can
--   be one of the following values: * <tt>NONE</tt> : Do not encrypt the
--   records in the stream. * <tt>KMS</tt> : Use server-side encryption on
--   the records in the stream using a customer-managed AWS KMS key.
sdEncryptionType :: Lens' StreamDescription (Maybe EncryptionType)

-- | 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<i>".You can also use a master key owned by Kinesis Data Streams
--   by specifying the alias @aws</i>kinesis<tt> . * Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@
sdKeyId :: Lens' StreamDescription (Maybe Text)

-- | The name of the stream being described.
sdStreamName :: Lens' StreamDescription Text

-- | The Amazon Resource Name (ARN) for the stream being described.
sdStreamARN :: Lens' StreamDescription Text

-- | The current status of the stream being described. The stream status is
--   one of the following states: * <tt>CREATING</tt> - The stream is being
--   created. Kinesis Data Streams immediately returns and sets
--   <tt>StreamStatus</tt> to <tt>CREATING</tt> . * <tt>DELETING</tt> - The
--   stream is being deleted. The specified stream is in the
--   <tt>DELETING</tt> state until Kinesis Data Streams completes the
--   deletion. * <tt>ACTIVE</tt> - The stream exists and is ready for read
--   and write operations or deletion. You should perform read and write
--   operations only on an <tt>ACTIVE</tt> stream. * <tt>UPDATING</tt> -
--   Shards in the stream are being merged or split. Read and write
--   operations continue to work while the stream is in the
--   <tt>UPDATING</tt> state.
sdStreamStatus :: Lens' StreamDescription StreamStatus

-- | The shards that comprise the stream.
sdShards :: Lens' StreamDescription [Shard]

-- | If set to <tt>true</tt> , more shards in the stream are available to
--   describe.
sdHasMoreShards :: Lens' StreamDescription Bool

-- | The current retention period, in hours.
sdRetentionPeriodHours :: Lens' StreamDescription Natural

-- | The approximate time that the stream was created.
sdStreamCreationTimestamp :: Lens' StreamDescription UTCTime

-- | Represents the current enhanced monitoring settings of the stream.
sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics]

-- | Represents the output for <tt>DescribeStreamSummary</tt>
--   
--   <i>See:</i> <a>streamDescriptionSummary</a> smart constructor.
data StreamDescriptionSummary

-- | Creates a value of <a>StreamDescriptionSummary</a> with the minimum
--   fields required to make a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>sdsEncryptionType</a> - The encryption type used. This value is
--   one of the following: * <tt>KMS</tt> * <tt>NONE</tt></li>
--   <li><a>sdsKeyId</a> - 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<i>".You can also use a master key owned by Kinesis
--   Data Streams by specifying the alias @aws</i>kinesis<tt> . * Key ARN
--   example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@</li>
--   <li><a>sdsStreamName</a> - The name of the stream being
--   described.</li>
--   <li><a>sdsStreamARN</a> - The Amazon Resource Name (ARN) for the
--   stream being described.</li>
--   <li><a>sdsStreamStatus</a> - The current status of the stream being
--   described. The stream status is one of the following states: *
--   <tt>CREATING</tt> - The stream is being created. Kinesis Data Streams
--   immediately returns and sets <tt>StreamStatus</tt> to
--   <tt>CREATING</tt> . * <tt>DELETING</tt> - The stream is being deleted.
--   The specified stream is in the <tt>DELETING</tt> state until Kinesis
--   Data Streams completes the deletion. * <tt>ACTIVE</tt> - The stream
--   exists and is ready for read and write operations or deletion. You
--   should perform read and write operations only on an <tt>ACTIVE</tt>
--   stream. * <tt>UPDATING</tt> - Shards in the stream are being merged or
--   split. Read and write operations continue to work while the stream is
--   in the <tt>UPDATING</tt> state.</li>
--   <li><a>sdsRetentionPeriodHours</a> - The current retention period, in
--   hours.</li>
--   <li><a>sdsStreamCreationTimestamp</a> - The approximate time that the
--   stream was created.</li>
--   <li><a>sdsEnhancedMonitoring</a> - Represents the current enhanced
--   monitoring settings of the stream.</li>
--   <li><a>sdsOpenShardCount</a> - The number of open shards in the
--   stream.</li>
--   </ul>
streamDescriptionSummary :: Text -> Text -> StreamStatus -> Natural -> UTCTime -> Natural -> StreamDescriptionSummary

-- | The encryption type used. This value is one of the following: *
--   <tt>KMS</tt> * <tt>NONE</tt>
sdsEncryptionType :: Lens' StreamDescriptionSummary (Maybe EncryptionType)

-- | 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<i>".You can also use a master key owned by Kinesis Data Streams
--   by specifying the alias @aws</i>kinesis<tt> . * Key ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:key<i>12345678-1234-1234-1234-123456789012<tt>
--   * Alias ARN example:
--   </tt>arn:aws:kms:us-east-1:123456789012:alias</i>MyAliasName<tt> *
--   Globally unique key ID example:
--   </tt>12345678-1234-1234-1234-123456789012<tt> * Alias name example:
--   </tt>alias<i>MyAliasName<tt> * Master key owned by Kinesis Data
--   Streams: </tt>alias</i>aws/kinesis@
sdsKeyId :: Lens' StreamDescriptionSummary (Maybe Text)

-- | The name of the stream being described.
sdsStreamName :: Lens' StreamDescriptionSummary Text

-- | The Amazon Resource Name (ARN) for the stream being described.
sdsStreamARN :: Lens' StreamDescriptionSummary Text

-- | The current status of the stream being described. The stream status is
--   one of the following states: * <tt>CREATING</tt> - The stream is being
--   created. Kinesis Data Streams immediately returns and sets
--   <tt>StreamStatus</tt> to <tt>CREATING</tt> . * <tt>DELETING</tt> - The
--   stream is being deleted. The specified stream is in the
--   <tt>DELETING</tt> state until Kinesis Data Streams completes the
--   deletion. * <tt>ACTIVE</tt> - The stream exists and is ready for read
--   and write operations or deletion. You should perform read and write
--   operations only on an <tt>ACTIVE</tt> stream. * <tt>UPDATING</tt> -
--   Shards in the stream are being merged or split. Read and write
--   operations continue to work while the stream is in the
--   <tt>UPDATING</tt> state.
sdsStreamStatus :: Lens' StreamDescriptionSummary StreamStatus

-- | The current retention period, in hours.
sdsRetentionPeriodHours :: Lens' StreamDescriptionSummary Natural

-- | The approximate time that the stream was created.
sdsStreamCreationTimestamp :: Lens' StreamDescriptionSummary UTCTime

-- | Represents the current enhanced monitoring settings of the stream.
sdsEnhancedMonitoring :: Lens' StreamDescriptionSummary [EnhancedMetrics]

-- | The number of open shards in the stream.
sdsOpenShardCount :: Lens' StreamDescriptionSummary Natural

-- | Metadata assigned to the stream, consisting of a key-value pair.
--   
--   <i>See:</i> <a>tag</a> smart constructor.
data Tag

-- | Creates a value of <a>Tag</a> with the minimum fields required to make
--   a request.
--   
--   Use one of the following lenses to modify other fields as desired:
--   
--   <ul>
--   <li><a>tagValue</a> - An optional string, typically used to describe
--   or define the tag. Maximum length: 256 characters. Valid characters:
--   Unicode letters, digits, white space, _ . / = + - % @</li>
--   <li><a>tagKey</a> - A unique identifier for the tag. Maximum length:
--   128 characters. Valid characters: Unicode letters, digits, white
--   space, _ . / = + - % @</li>
--   </ul>
tag :: Text -> Tag

-- | An optional string, typically used to describe or define the tag.
--   Maximum length: 256 characters. Valid characters: Unicode letters,
--   digits, white space, _ . / = + - % @
tagValue :: Lens' Tag (Maybe Text)

-- | A unique identifier for the tag. Maximum length: 128 characters. Valid
--   characters: Unicode letters, digits, white space, _ . / = + - % @
tagKey :: Lens' Tag Text
