Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Kinesis

Contents

Service Configuration
Errors
Waiters
- StreamExists
- StreamNotExists
Operations
Types

Description

Derived from API version 2013-12-02 of the AWS service descriptions, licensed under Apache 2.0.

Amazon Kinesis Data Streams Service API Reference

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

Synopsis

defaultService :: Service
_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
_KMSThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
_ExpiredIteratorException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
_KMSOptInRequired :: AsError a => Getting (First ServiceError) a ServiceError
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
_KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
_KMSAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
newStreamExists :: Wait DescribeStream
newStreamNotExists :: Wait DescribeStream
data PutRecord = PutRecord' (Maybe Text) (Maybe Text) Text Base64 Text
newPutRecord :: Text -> ByteString -> Text -> PutRecord
data PutRecordResponse = PutRecordResponse' (Maybe EncryptionType) Int Text Text
newPutRecordResponse :: Int -> Text -> Text -> PutRecordResponse
data SubscribeToShard = SubscribeToShard' Text Text StartingPosition
newSubscribeToShard :: Text -> Text -> StartingPosition -> SubscribeToShard
data SubscribeToShardResponse = SubscribeToShardResponse' Int Value
newSubscribeToShardResponse :: Int -> Value -> SubscribeToShardResponse
data DecreaseStreamRetentionPeriod = DecreaseStreamRetentionPeriod' Text Int
newDecreaseStreamRetentionPeriod :: Text -> Int -> DecreaseStreamRetentionPeriod
data DecreaseStreamRetentionPeriodResponse = DecreaseStreamRetentionPeriodResponse' {
}
newDecreaseStreamRetentionPeriodResponse :: DecreaseStreamRetentionPeriodResponse
data MergeShards = MergeShards' Text Text Text
newMergeShards :: Text -> Text -> Text -> MergeShards
data MergeShardsResponse = MergeShardsResponse' {
}
newMergeShardsResponse :: MergeShardsResponse
data DeregisterStreamConsumer = DeregisterStreamConsumer' (Maybe Text) (Maybe Text) (Maybe Text)
newDeregisterStreamConsumer :: DeregisterStreamConsumer
data DeregisterStreamConsumerResponse = DeregisterStreamConsumerResponse' {
}
newDeregisterStreamConsumerResponse :: DeregisterStreamConsumerResponse
data DescribeStreamSummary = DescribeStreamSummary' Text
newDescribeStreamSummary :: Text -> DescribeStreamSummary
data DescribeStreamSummaryResponse = DescribeStreamSummaryResponse' Int StreamDescriptionSummary
newDescribeStreamSummaryResponse :: Int -> StreamDescriptionSummary -> DescribeStreamSummaryResponse
data GetShardIterator = GetShardIterator' (Maybe Text) (Maybe POSIX) Text Text ShardIteratorType
newGetShardIterator :: Text -> Text -> ShardIteratorType -> GetShardIterator
data GetShardIteratorResponse = GetShardIteratorResponse' (Maybe Text) Int
newGetShardIteratorResponse :: Int -> GetShardIteratorResponse
data GetRecords = GetRecords' (Maybe Natural) Text
newGetRecords :: Text -> GetRecords
data GetRecordsResponse = GetRecordsResponse' (Maybe Text) (Maybe Natural) (Maybe [ChildShard]) Int [Record]
newGetRecordsResponse :: Int -> GetRecordsResponse
data StopStreamEncryption = StopStreamEncryption' Text EncryptionType Text
newStopStreamEncryption :: Text -> EncryptionType -> Text -> StopStreamEncryption
data StopStreamEncryptionResponse = StopStreamEncryptionResponse' {
}
newStopStreamEncryptionResponse :: StopStreamEncryptionResponse
data EnableEnhancedMonitoring = EnableEnhancedMonitoring' Text [MetricsName]
newEnableEnhancedMonitoring :: Text -> EnableEnhancedMonitoring
data EnhancedMonitoringOutput = EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text)
newEnhancedMonitoringOutput :: EnhancedMonitoringOutput
data DescribeLimits = DescribeLimits' {
}
newDescribeLimits :: DescribeLimits
data DescribeLimitsResponse = DescribeLimitsResponse' Int Natural Natural
newDescribeLimitsResponse :: Int -> Natural -> Natural -> DescribeLimitsResponse
data RegisterStreamConsumer = RegisterStreamConsumer' Text Text
newRegisterStreamConsumer :: Text -> Text -> RegisterStreamConsumer
data RegisterStreamConsumerResponse = RegisterStreamConsumerResponse' Int Consumer
newRegisterStreamConsumerResponse :: Int -> Consumer -> RegisterStreamConsumerResponse
data DisableEnhancedMonitoring = DisableEnhancedMonitoring' Text [MetricsName]
newDisableEnhancedMonitoring :: Text -> DisableEnhancedMonitoring
data EnhancedMonitoringOutput = EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text)
newEnhancedMonitoringOutput :: EnhancedMonitoringOutput
data UpdateShardCount = UpdateShardCount' Text Natural ScalingType
newUpdateShardCount :: Text -> Natural -> ScalingType -> UpdateShardCount
data UpdateShardCountResponse = UpdateShardCountResponse' (Maybe Natural) (Maybe Text) (Maybe Natural) Int
newUpdateShardCountResponse :: Int -> UpdateShardCountResponse
data ListTagsForStream = ListTagsForStream' (Maybe Natural) (Maybe Text) Text
newListTagsForStream :: Text -> ListTagsForStream
data ListTagsForStreamResponse = ListTagsForStreamResponse' Int [Tag] Bool
newListTagsForStreamResponse :: Int -> Bool -> ListTagsForStreamResponse
data DescribeStreamConsumer = DescribeStreamConsumer' (Maybe Text) (Maybe Text) (Maybe Text)
newDescribeStreamConsumer :: DescribeStreamConsumer
data DescribeStreamConsumerResponse = DescribeStreamConsumerResponse' Int ConsumerDescription
newDescribeStreamConsumerResponse :: Int -> ConsumerDescription -> DescribeStreamConsumerResponse
data AddTagsToStream = AddTagsToStream' Text (HashMap Text Text)
newAddTagsToStream :: Text -> AddTagsToStream
data AddTagsToStreamResponse = AddTagsToStreamResponse' {
}
newAddTagsToStreamResponse :: AddTagsToStreamResponse
data PutRecords = PutRecords' (NonEmpty PutRecordsRequestEntry) Text
newPutRecords :: NonEmpty PutRecordsRequestEntry -> Text -> PutRecords
data PutRecordsResponse = PutRecordsResponse' (Maybe EncryptionType) (Maybe Natural) Int (NonEmpty PutRecordsResultEntry)
newPutRecordsResponse :: Int -> NonEmpty PutRecordsResultEntry -> PutRecordsResponse
data ListShards = ListShards' (Maybe ShardFilter) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural)
newListShards :: ListShards
data ListShardsResponse = ListShardsResponse' (Maybe Text) (Maybe [Shard]) Int
newListShardsResponse :: Int -> ListShardsResponse
data DeleteStream = DeleteStream' (Maybe Bool) Text
newDeleteStream :: Text -> DeleteStream
data DeleteStreamResponse = DeleteStreamResponse' {
}
newDeleteStreamResponse :: DeleteStreamResponse
data RemoveTagsFromStream = RemoveTagsFromStream' Text (NonEmpty Text)
newRemoveTagsFromStream :: Text -> NonEmpty Text -> RemoveTagsFromStream
data RemoveTagsFromStreamResponse = RemoveTagsFromStreamResponse' {
}
newRemoveTagsFromStreamResponse :: RemoveTagsFromStreamResponse
data ListStreams = ListStreams' (Maybe Natural) (Maybe Text)
newListStreams :: ListStreams
data ListStreamsResponse = ListStreamsResponse' Int [Text] Bool
newListStreamsResponse :: Int -> Bool -> ListStreamsResponse
data CreateStream = CreateStream' Text Natural
newCreateStream :: Text -> Natural -> CreateStream
data CreateStreamResponse = CreateStreamResponse' {
}
newCreateStreamResponse :: CreateStreamResponse
data StartStreamEncryption = StartStreamEncryption' Text EncryptionType Text
newStartStreamEncryption :: Text -> EncryptionType -> Text -> StartStreamEncryption
data StartStreamEncryptionResponse = StartStreamEncryptionResponse' {
}
newStartStreamEncryptionResponse :: StartStreamEncryptionResponse
data ListStreamConsumers = ListStreamConsumers' (Maybe Text) (Maybe POSIX) (Maybe Natural) Text
newListStreamConsumers :: Text -> ListStreamConsumers
data ListStreamConsumersResponse = ListStreamConsumersResponse' (Maybe Text) (Maybe [Consumer]) Int
newListStreamConsumersResponse :: Int -> ListStreamConsumersResponse
data SplitShard = SplitShard' Text Text Text
newSplitShard :: Text -> Text -> Text -> SplitShard
data SplitShardResponse = SplitShardResponse' {
}
newSplitShardResponse :: SplitShardResponse
data IncreaseStreamRetentionPeriod = IncreaseStreamRetentionPeriod' Text Int
newIncreaseStreamRetentionPeriod :: Text -> Int -> IncreaseStreamRetentionPeriod
data IncreaseStreamRetentionPeriodResponse = IncreaseStreamRetentionPeriodResponse' {
}
newIncreaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse
data DescribeStream = DescribeStream' (Maybe Text) (Maybe Natural) Text
newDescribeStream :: Text -> DescribeStream
data DescribeStreamResponse = DescribeStreamResponse' Int StreamDescription
newDescribeStreamResponse :: Int -> StreamDescription -> DescribeStreamResponse
newtype ConsumerStatus where
- ConsumerStatus' {
  - fromConsumerStatus :: Text
  }
- pattern ConsumerStatus_ACTIVE :: ConsumerStatus
- pattern ConsumerStatus_CREATING :: ConsumerStatus
- pattern ConsumerStatus_DELETING :: ConsumerStatus
newtype EncryptionType where
- EncryptionType' {
  - fromEncryptionType :: Text
  }
- pattern EncryptionType_KMS :: EncryptionType
- pattern EncryptionType_NONE :: EncryptionType
newtype MetricsName where
- MetricsName' {
  - fromMetricsName :: Text
  }
- pattern MetricsName_ALL :: MetricsName
- pattern MetricsName_IncomingBytes :: MetricsName
- pattern MetricsName_IncomingRecords :: MetricsName
- pattern MetricsName_IteratorAgeMilliseconds :: MetricsName
- pattern MetricsName_OutgoingBytes :: MetricsName
- pattern MetricsName_OutgoingRecords :: MetricsName
- pattern MetricsName_ReadProvisionedThroughputExceeded :: MetricsName
- pattern MetricsName_WriteProvisionedThroughputExceeded :: MetricsName
newtype ScalingType where
- ScalingType' {
  - fromScalingType :: Text
  }
- pattern ScalingType_UNIFORM_SCALING :: ScalingType
newtype ShardFilterType where
- ShardFilterType' {
  - fromShardFilterType :: Text
  }
- pattern ShardFilterType_AFTER_SHARD_ID :: ShardFilterType
- pattern ShardFilterType_AT_LATEST :: ShardFilterType
- pattern ShardFilterType_AT_TIMESTAMP :: ShardFilterType
- pattern ShardFilterType_AT_TRIM_HORIZON :: ShardFilterType
- pattern ShardFilterType_FROM_TIMESTAMP :: ShardFilterType
- pattern ShardFilterType_FROM_TRIM_HORIZON :: ShardFilterType
newtype ShardIteratorType where
- ShardIteratorType' {
  - fromShardIteratorType :: Text
  }
- pattern ShardIteratorType_AFTER_SEQUENCE_NUMBER :: ShardIteratorType
- pattern ShardIteratorType_AT_SEQUENCE_NUMBER :: ShardIteratorType
- pattern ShardIteratorType_AT_TIMESTAMP :: ShardIteratorType
- pattern ShardIteratorType_LATEST :: ShardIteratorType
- pattern ShardIteratorType_TRIM_HORIZON :: ShardIteratorType
newtype StreamStatus where
- StreamStatus' {
  - fromStreamStatus :: Text
  }
- pattern StreamStatus_ACTIVE :: StreamStatus
- pattern StreamStatus_CREATING :: StreamStatus
- pattern StreamStatus_DELETING :: StreamStatus
- pattern StreamStatus_UPDATING :: StreamStatus
data ChildShard = ChildShard' Text [Text] HashKeyRange
newChildShard :: Text -> HashKeyRange -> ChildShard
data Consumer = Consumer' Text Text ConsumerStatus POSIX
newConsumer :: Text -> Text -> ConsumerStatus -> UTCTime -> Consumer
data ConsumerDescription = ConsumerDescription' Text Text ConsumerStatus POSIX Text
newConsumerDescription :: Text -> Text -> ConsumerStatus -> UTCTime -> Text -> ConsumerDescription
data EnhancedMetrics = EnhancedMetrics' (Maybe [MetricsName])
newEnhancedMetrics :: EnhancedMetrics
data EnhancedMonitoringOutput = EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text)
newEnhancedMonitoringOutput :: EnhancedMonitoringOutput
data HashKeyRange = HashKeyRange' Text Text
newHashKeyRange :: Text -> Text -> HashKeyRange
data PutRecordsRequestEntry = PutRecordsRequestEntry' (Maybe Text) Base64 Text
newPutRecordsRequestEntry :: ByteString -> Text -> PutRecordsRequestEntry
data PutRecordsResultEntry = PutRecordsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newPutRecordsResultEntry :: PutRecordsResultEntry
data Record = Record' (Maybe EncryptionType) (Maybe POSIX) Text Base64 Text
newRecord :: Text -> ByteString -> Text -> Record
data SequenceNumberRange = SequenceNumberRange' (Maybe Text) Text
newSequenceNumberRange :: Text -> SequenceNumberRange
data Shard = Shard' (Maybe Text) (Maybe Text) Text HashKeyRange SequenceNumberRange
newShard :: Text -> HashKeyRange -> SequenceNumberRange -> Shard
data ShardFilter = ShardFilter' (Maybe POSIX) (Maybe Text) ShardFilterType
newShardFilter :: ShardFilterType -> ShardFilter
data StartingPosition = StartingPosition' (Maybe Text) (Maybe POSIX) ShardIteratorType
newStartingPosition :: ShardIteratorType -> StartingPosition
data StreamDescription = StreamDescription' (Maybe EncryptionType) (Maybe Text) Text Text StreamStatus [Shard] Bool Int POSIX [EnhancedMetrics]
newStreamDescription :: Text -> Text -> StreamStatus -> Bool -> Int -> UTCTime -> StreamDescription
data StreamDescriptionSummary = StreamDescriptionSummary' (Maybe EncryptionType) (Maybe Text) (Maybe Natural) Text Text StreamStatus Int POSIX [EnhancedMetrics] Natural
newStreamDescriptionSummary :: Text -> Text -> StreamStatus -> Int -> UTCTime -> Natural -> StreamDescriptionSummary
data SubscribeToShardEvent = SubscribeToShardEvent' (Maybe [ChildShard]) [Record] Text Natural
newSubscribeToShardEvent :: Text -> Natural -> SubscribeToShardEvent
data Tag = Tag' (Maybe Text) Text
newTag :: Text -> Tag

Service Configuration

defaultService :: Service Source #

API version 2013-12-02 of the Amazon Kinesis SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Kinesis.

KMSInvalidStateException

_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

KMSThrottlingException

_KMSThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.

ExpiredIteratorException

_ExpiredIteratorException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided iterator exceeds the maximum age allowed.

InvalidArgumentException

_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

KMSOptInRequired

_KMSOptInRequired :: AsError a => Getting (First ServiceError) a ServiceError Source #

The AWS access key ID needs a subscription for the service.

ProvisionedThroughputExceededException

_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.

KMSNotFoundException

_KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was rejected because the specified entity or resource can't be found.

ExpiredNextTokenException

_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The pagination token passed to the operation is expired.

KMSDisabledException

_KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was rejected because the specified customer master key (CMK) isn't enabled.

InternalFailureException

_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The processing of the request failed because of an unknown error, exception, or failure.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The requested resource could not be found. The stream might not be specified correctly.

KMSAccessDeniedException

_KMSAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The ciphertext references a key that doesn't exist or that you don't have access to.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceInUseException

_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

StreamExists

newStreamExists :: Wait DescribeStream Source #

Polls DescribeStream every 10 seconds until a successful state is reached. An error is returned after 18 failed checks.

StreamNotExists

newStreamNotExists :: Wait DescribeStream Source #

Polls DescribeStream every 10 seconds until a successful state is reached. An error is returned after 18 failed checks.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

PutRecord

data PutRecord Source #

Represents the input for PutRecord.

See: newPutRecord smart constructor.

Constructors

PutRecord' (Maybe Text) (Maybe Text) Text Base64 Text

Instances

Instances details

Eq PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods (==) :: PutRecord -> PutRecord -> Bool # (/=) :: PutRecord -> PutRecord -> Bool #
Read PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods readsPrec :: Int -> ReadS PutRecord # readList :: ReadS [PutRecord] # readPrec :: ReadPrec PutRecord # readListPrec :: ReadPrec [PutRecord] #
Show PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods showsPrec :: Int -> PutRecord -> ShowS # show :: PutRecord -> String # showList :: [PutRecord] -> ShowS #
Generic PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Associated Types type Rep PutRecord :: Type -> Type # Methods from :: PutRecord -> Rep PutRecord x # to :: Rep PutRecord x -> PutRecord #
NFData PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods rnf :: PutRecord -> () #
Hashable PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods hashWithSalt :: Int -> PutRecord -> Int # hash :: PutRecord -> Int #
ToJSON PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods toJSON :: PutRecord -> Value # toEncoding :: PutRecord -> Encoding # toJSONList :: [PutRecord] -> Value # toEncodingList :: [PutRecord] -> Encoding #
AWSRequest PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Associated Types type AWSResponse PutRecord # Methods request :: PutRecord -> Request PutRecord # response :: MonadResource m => Logger -> Service -> Proxy PutRecord -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutRecord))) #
ToHeaders PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods toHeaders :: PutRecord -> [Header] #
ToPath PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods toPath :: PutRecord -> ByteString #
ToQuery PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods toQuery :: PutRecord -> QueryString #
type Rep PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord type Rep PutRecord = D1 ('MetaData "PutRecord" "Amazonka.Kinesis.PutRecord" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "PutRecord'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "explicitHashKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sequenceNumberForOrdering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :: S1 ('MetaSel ('Just "partitionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutRecord Source #
Instance details Defined in Amazonka.Kinesis.PutRecord type AWSResponse PutRecord = PutRecordResponse

newPutRecord Source #

Arguments

:: Text	`$sel:streamName:PutRecord'`
-> ByteString	`$sel:data':PutRecord'`
-> Text	`$sel:partitionKey:PutRecord'`
-> PutRecord

Create a value of PutRecord with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:explicitHashKey:PutRecord', putRecord_explicitHashKey - The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

$sel:sequenceNumberForOrdering:PutRecord', putRecord_sequenceNumberForOrdering - Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

$sel:streamName:PutRecord', putRecord_streamName - The name of the stream to put the data record into.

$sel:data':PutRecord', putRecord_data - The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MiB).-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:partitionKey:PutRecord', putRecord_partitionKey - Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

data PutRecordResponse Source #

Represents the output for PutRecord.

See: newPutRecordResponse smart constructor.

Constructors

PutRecordResponse' (Maybe EncryptionType) Int Text Text

Instances

Instances details

Eq PutRecordResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods (==) :: PutRecordResponse -> PutRecordResponse -> Bool # (/=) :: PutRecordResponse -> PutRecordResponse -> Bool #
Read PutRecordResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods readsPrec :: Int -> ReadS PutRecordResponse # readList :: ReadS [PutRecordResponse] # readPrec :: ReadPrec PutRecordResponse # readListPrec :: ReadPrec [PutRecordResponse] #
Show PutRecordResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods showsPrec :: Int -> PutRecordResponse -> ShowS # show :: PutRecordResponse -> String # showList :: [PutRecordResponse] -> ShowS #
Generic PutRecordResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Associated Types type Rep PutRecordResponse :: Type -> Type # Methods from :: PutRecordResponse -> Rep PutRecordResponse x # to :: Rep PutRecordResponse x -> PutRecordResponse #
NFData PutRecordResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecord Methods rnf :: PutRecordResponse -> () #
type Rep PutRecordResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecord type Rep PutRecordResponse = D1 ('MetaData "PutRecordResponse" "Amazonka.Kinesis.PutRecord" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "PutRecordResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionType)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutRecordResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutRecordResponse'`
-> Text	`$sel:shardId:PutRecordResponse'`
-> Text	`$sel:sequenceNumber:PutRecordResponse'`
-> PutRecordResponse

Create a value of PutRecordResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionType:PutRecordResponse', putRecordResponse_encryptionType - The encryption type to use on the record. This parameter can be one of the following values:

NONE: Do not encrypt the records in the stream.
KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

$sel:httpStatus:PutRecordResponse', putRecordResponse_httpStatus - The response's http status code.

$sel:shardId:PutRecordResponse', putRecordResponse_shardId - The shard ID of the shard where the data record was placed.

$sel:sequenceNumber:PutRecordResponse', putRecordResponse_sequenceNumber - The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

SubscribeToShard

data SubscribeToShard Source #

See: newSubscribeToShard smart constructor.

Constructors

SubscribeToShard' Text Text StartingPosition

Instances

Instances details

Eq SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods (==) :: SubscribeToShard -> SubscribeToShard -> Bool # (/=) :: SubscribeToShard -> SubscribeToShard -> Bool #
Read SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods readsPrec :: Int -> ReadS SubscribeToShard # readList :: ReadS [SubscribeToShard] # readPrec :: ReadPrec SubscribeToShard # readListPrec :: ReadPrec [SubscribeToShard] #
Show SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods showsPrec :: Int -> SubscribeToShard -> ShowS # show :: SubscribeToShard -> String # showList :: [SubscribeToShard] -> ShowS #
Generic SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Associated Types type Rep SubscribeToShard :: Type -> Type # Methods from :: SubscribeToShard -> Rep SubscribeToShard x # to :: Rep SubscribeToShard x -> SubscribeToShard #
NFData SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods rnf :: SubscribeToShard -> () #
Hashable SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods hashWithSalt :: Int -> SubscribeToShard -> Int # hash :: SubscribeToShard -> Int #
ToJSON SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods toJSON :: SubscribeToShard -> Value # toEncoding :: SubscribeToShard -> Encoding # toJSONList :: [SubscribeToShard] -> Value # toEncodingList :: [SubscribeToShard] -> Encoding #
AWSRequest SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Associated Types type AWSResponse SubscribeToShard # Methods request :: SubscribeToShard -> Request SubscribeToShard # response :: MonadResource m => Logger -> Service -> Proxy SubscribeToShard -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SubscribeToShard))) #
ToHeaders SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods toHeaders :: SubscribeToShard -> [Header] #
ToPath SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods toPath :: SubscribeToShard -> ByteString #
ToQuery SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods toQuery :: SubscribeToShard -> QueryString #
type Rep SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard type Rep SubscribeToShard = D1 ('MetaData "SubscribeToShard" "Amazonka.Kinesis.SubscribeToShard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SubscribeToShard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "startingPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StartingPosition))))
type AWSResponse SubscribeToShard Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard type AWSResponse SubscribeToShard = SubscribeToShardResponse

newSubscribeToShard Source #

Arguments

:: Text	`$sel:consumerARN:SubscribeToShard'`
-> Text	`$sel:shardId:SubscribeToShard'`
-> StartingPosition	`$sel:startingPosition:SubscribeToShard'`
-> SubscribeToShard

Create a value of SubscribeToShard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:consumerARN:SubscribeToShard', subscribeToShard_consumerARN - For this parameter, use the value you obtained when you called RegisterStreamConsumer.

$sel:shardId:SubscribeToShard', subscribeToShard_shardId - The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

$sel:startingPosition:SubscribeToShard', subscribeToShard_startingPosition -

data SubscribeToShardResponse Source #

See: newSubscribeToShardResponse smart constructor.

Constructors

SubscribeToShardResponse' Int Value

Instances

Instances details

Generic SubscribeToShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Associated Types type Rep SubscribeToShardResponse :: Type -> Type # Methods from :: SubscribeToShardResponse -> Rep SubscribeToShardResponse x # to :: Rep SubscribeToShardResponse x -> SubscribeToShardResponse #
NFData SubscribeToShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard Methods rnf :: SubscribeToShardResponse -> () #
type Rep SubscribeToShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SubscribeToShard type Rep SubscribeToShardResponse = D1 ('MetaData "SubscribeToShardResponse" "Amazonka.Kinesis.SubscribeToShard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SubscribeToShardResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "eventStream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value)))

newSubscribeToShardResponse Source #

Arguments

:: Int	`$sel:httpStatus:SubscribeToShardResponse'`
-> Value	`$sel:eventStream:SubscribeToShardResponse'`
-> SubscribeToShardResponse

Create a value of SubscribeToShardResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SubscribeToShardResponse', subscribeToShardResponse_httpStatus - The response's http status code.

$sel:eventStream:SubscribeToShardResponse', subscribeToShardResponse_eventStream - The event stream that your consumer can use to read records from the shard.

DecreaseStreamRetentionPeriod

data DecreaseStreamRetentionPeriod Source #

Represents the input for DecreaseStreamRetentionPeriod.

See: newDecreaseStreamRetentionPeriod smart constructor.

Constructors

DecreaseStreamRetentionPeriod' Text Int

Instances

Instances details

Eq DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods (==) :: DecreaseStreamRetentionPeriod -> DecreaseStreamRetentionPeriod -> Bool # (/=) :: DecreaseStreamRetentionPeriod -> DecreaseStreamRetentionPeriod -> Bool #
Read DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods readsPrec :: Int -> ReadS DecreaseStreamRetentionPeriod # readList :: ReadS [DecreaseStreamRetentionPeriod] # readPrec :: ReadPrec DecreaseStreamRetentionPeriod # readListPrec :: ReadPrec [DecreaseStreamRetentionPeriod] #
Show DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods showsPrec :: Int -> DecreaseStreamRetentionPeriod -> ShowS # show :: DecreaseStreamRetentionPeriod -> String # showList :: [DecreaseStreamRetentionPeriod] -> ShowS #
Generic DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Associated Types type Rep DecreaseStreamRetentionPeriod :: Type -> Type # Methods from :: DecreaseStreamRetentionPeriod -> Rep DecreaseStreamRetentionPeriod x # to :: Rep DecreaseStreamRetentionPeriod x -> DecreaseStreamRetentionPeriod #
NFData DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods rnf :: DecreaseStreamRetentionPeriod -> () #
Hashable DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods hashWithSalt :: Int -> DecreaseStreamRetentionPeriod -> Int # hash :: DecreaseStreamRetentionPeriod -> Int #
ToJSON DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods toJSON :: DecreaseStreamRetentionPeriod -> Value # toEncoding :: DecreaseStreamRetentionPeriod -> Encoding # toJSONList :: [DecreaseStreamRetentionPeriod] -> Value # toEncodingList :: [DecreaseStreamRetentionPeriod] -> Encoding #
AWSRequest DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Associated Types type AWSResponse DecreaseStreamRetentionPeriod # Methods request :: DecreaseStreamRetentionPeriod -> Request DecreaseStreamRetentionPeriod # response :: MonadResource m => Logger -> Service -> Proxy DecreaseStreamRetentionPeriod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DecreaseStreamRetentionPeriod))) #
ToHeaders DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods toHeaders :: DecreaseStreamRetentionPeriod -> [Header] #
ToPath DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods toPath :: DecreaseStreamRetentionPeriod -> ByteString #
ToQuery DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods toQuery :: DecreaseStreamRetentionPeriod -> QueryString #
type Rep DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod type Rep DecreaseStreamRetentionPeriod = D1 ('MetaData "DecreaseStreamRetentionPeriod" "Amazonka.Kinesis.DecreaseStreamRetentionPeriod" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DecreaseStreamRetentionPeriod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "retentionPeriodHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))
type AWSResponse DecreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod type AWSResponse DecreaseStreamRetentionPeriod = DecreaseStreamRetentionPeriodResponse

newDecreaseStreamRetentionPeriod Source #

Arguments

:: Text	`$sel:streamName:DecreaseStreamRetentionPeriod'`
-> Int	`$sel:retentionPeriodHours:DecreaseStreamRetentionPeriod'`
-> DecreaseStreamRetentionPeriod

Create a value of DecreaseStreamRetentionPeriod with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:DecreaseStreamRetentionPeriod', decreaseStreamRetentionPeriod_streamName - The name of the stream to modify.

$sel:retentionPeriodHours:DecreaseStreamRetentionPeriod', decreaseStreamRetentionPeriod_retentionPeriodHours - The new retention period of the stream, in hours. Must be less than the current retention period.

data DecreaseStreamRetentionPeriodResponse Source #

See: newDecreaseStreamRetentionPeriodResponse smart constructor.

Constructors

DecreaseStreamRetentionPeriodResponse'

Instances

Instances details

Eq DecreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods (==) :: DecreaseStreamRetentionPeriodResponse -> DecreaseStreamRetentionPeriodResponse -> Bool # (/=) :: DecreaseStreamRetentionPeriodResponse -> DecreaseStreamRetentionPeriodResponse -> Bool #
Read DecreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods readsPrec :: Int -> ReadS DecreaseStreamRetentionPeriodResponse # readList :: ReadS [DecreaseStreamRetentionPeriodResponse] # readPrec :: ReadPrec DecreaseStreamRetentionPeriodResponse # readListPrec :: ReadPrec [DecreaseStreamRetentionPeriodResponse] #
Show DecreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods showsPrec :: Int -> DecreaseStreamRetentionPeriodResponse -> ShowS # show :: DecreaseStreamRetentionPeriodResponse -> String # showList :: [DecreaseStreamRetentionPeriodResponse] -> ShowS #
Generic DecreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Associated Types type Rep DecreaseStreamRetentionPeriodResponse :: Type -> Type # Methods from :: DecreaseStreamRetentionPeriodResponse -> Rep DecreaseStreamRetentionPeriodResponse x # to :: Rep DecreaseStreamRetentionPeriodResponse x -> DecreaseStreamRetentionPeriodResponse #
NFData DecreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod Methods rnf :: DecreaseStreamRetentionPeriodResponse -> () #
type Rep DecreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.DecreaseStreamRetentionPeriod type Rep DecreaseStreamRetentionPeriodResponse = D1 ('MetaData "DecreaseStreamRetentionPeriodResponse" "Amazonka.Kinesis.DecreaseStreamRetentionPeriod" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DecreaseStreamRetentionPeriodResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDecreaseStreamRetentionPeriodResponse :: DecreaseStreamRetentionPeriodResponse Source #

Create a value of DecreaseStreamRetentionPeriodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

MergeShards

data MergeShards Source #

Represents the input for MergeShards.

See: newMergeShards smart constructor.

Constructors

MergeShards' Text Text Text

Instances

Instances details

Eq MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods (==) :: MergeShards -> MergeShards -> Bool # (/=) :: MergeShards -> MergeShards -> Bool #
Read MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods readsPrec :: Int -> ReadS MergeShards # readList :: ReadS [MergeShards] # readPrec :: ReadPrec MergeShards # readListPrec :: ReadPrec [MergeShards] #
Show MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods showsPrec :: Int -> MergeShards -> ShowS # show :: MergeShards -> String # showList :: [MergeShards] -> ShowS #
Generic MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Associated Types type Rep MergeShards :: Type -> Type # Methods from :: MergeShards -> Rep MergeShards x # to :: Rep MergeShards x -> MergeShards #
NFData MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods rnf :: MergeShards -> () #
Hashable MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods hashWithSalt :: Int -> MergeShards -> Int # hash :: MergeShards -> Int #
ToJSON MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods toJSON :: MergeShards -> Value # toEncoding :: MergeShards -> Encoding # toJSONList :: [MergeShards] -> Value # toEncodingList :: [MergeShards] -> Encoding #
AWSRequest MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Associated Types type AWSResponse MergeShards # Methods request :: MergeShards -> Request MergeShards # response :: MonadResource m => Logger -> Service -> Proxy MergeShards -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse MergeShards))) #
ToHeaders MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods toHeaders :: MergeShards -> [Header] #
ToPath MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods toPath :: MergeShards -> ByteString #
ToQuery MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods toQuery :: MergeShards -> QueryString #
type Rep MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards type Rep MergeShards = D1 ('MetaData "MergeShards" "Amazonka.Kinesis.MergeShards" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "MergeShards'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "shardToMerge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "adjacentShardToMerge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse MergeShards Source #
Instance details Defined in Amazonka.Kinesis.MergeShards type AWSResponse MergeShards = MergeShardsResponse

newMergeShards Source #

Arguments

:: Text	`$sel:streamName:MergeShards'`
-> Text	`$sel:shardToMerge:MergeShards'`
-> Text	`$sel:adjacentShardToMerge:MergeShards'`
-> MergeShards

Create a value of MergeShards with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:MergeShards', mergeShards_streamName - The name of the stream for the merge.

$sel:shardToMerge:MergeShards', mergeShards_shardToMerge - The shard ID of the shard to combine with the adjacent shard for the merge.

$sel:adjacentShardToMerge:MergeShards', mergeShards_adjacentShardToMerge - The shard ID of the adjacent shard for the merge.

data MergeShardsResponse Source #

See: newMergeShardsResponse smart constructor.

Constructors

MergeShardsResponse'

Instances

Instances details

Eq MergeShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods (==) :: MergeShardsResponse -> MergeShardsResponse -> Bool # (/=) :: MergeShardsResponse -> MergeShardsResponse -> Bool #
Read MergeShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods readsPrec :: Int -> ReadS MergeShardsResponse # readList :: ReadS [MergeShardsResponse] # readPrec :: ReadPrec MergeShardsResponse # readListPrec :: ReadPrec [MergeShardsResponse] #
Show MergeShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods showsPrec :: Int -> MergeShardsResponse -> ShowS # show :: MergeShardsResponse -> String # showList :: [MergeShardsResponse] -> ShowS #
Generic MergeShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Associated Types type Rep MergeShardsResponse :: Type -> Type # Methods from :: MergeShardsResponse -> Rep MergeShardsResponse x # to :: Rep MergeShardsResponse x -> MergeShardsResponse #
NFData MergeShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.MergeShards Methods rnf :: MergeShardsResponse -> () #
type Rep MergeShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.MergeShards type Rep MergeShardsResponse = D1 ('MetaData "MergeShardsResponse" "Amazonka.Kinesis.MergeShards" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "MergeShardsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newMergeShardsResponse :: MergeShardsResponse Source #

Create a value of MergeShardsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeregisterStreamConsumer

data DeregisterStreamConsumer Source #

See: newDeregisterStreamConsumer smart constructor.

Constructors

DeregisterStreamConsumer' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods (==) :: DeregisterStreamConsumer -> DeregisterStreamConsumer -> Bool # (/=) :: DeregisterStreamConsumer -> DeregisterStreamConsumer -> Bool #
Read DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods readsPrec :: Int -> ReadS DeregisterStreamConsumer # readList :: ReadS [DeregisterStreamConsumer] # readPrec :: ReadPrec DeregisterStreamConsumer # readListPrec :: ReadPrec [DeregisterStreamConsumer] #
Show DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods showsPrec :: Int -> DeregisterStreamConsumer -> ShowS # show :: DeregisterStreamConsumer -> String # showList :: [DeregisterStreamConsumer] -> ShowS #
Generic DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Associated Types type Rep DeregisterStreamConsumer :: Type -> Type # Methods from :: DeregisterStreamConsumer -> Rep DeregisterStreamConsumer x # to :: Rep DeregisterStreamConsumer x -> DeregisterStreamConsumer #
NFData DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods rnf :: DeregisterStreamConsumer -> () #
Hashable DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods hashWithSalt :: Int -> DeregisterStreamConsumer -> Int # hash :: DeregisterStreamConsumer -> Int #
ToJSON DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toJSON :: DeregisterStreamConsumer -> Value # toEncoding :: DeregisterStreamConsumer -> Encoding # toJSONList :: [DeregisterStreamConsumer] -> Value # toEncodingList :: [DeregisterStreamConsumer] -> Encoding #
AWSRequest DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Associated Types type AWSResponse DeregisterStreamConsumer # Methods request :: DeregisterStreamConsumer -> Request DeregisterStreamConsumer # response :: MonadResource m => Logger -> Service -> Proxy DeregisterStreamConsumer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeregisterStreamConsumer))) #
ToHeaders DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toHeaders :: DeregisterStreamConsumer -> [Header] #
ToPath DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toPath :: DeregisterStreamConsumer -> ByteString #
ToQuery DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toQuery :: DeregisterStreamConsumer -> QueryString #
type Rep DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer type Rep DeregisterStreamConsumer = D1 ('MetaData "DeregisterStreamConsumer" "Amazonka.Kinesis.DeregisterStreamConsumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DeregisterStreamConsumer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer type AWSResponse DeregisterStreamConsumer = DeregisterStreamConsumerResponse

newDeregisterStreamConsumer :: DeregisterStreamConsumer Source #

Create a value of DeregisterStreamConsumer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:consumerARN:DeregisterStreamConsumer', deregisterStreamConsumer_consumerARN - The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

$sel:streamARN:DeregisterStreamConsumer', deregisterStreamConsumer_streamARN - The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

$sel:consumerName:DeregisterStreamConsumer', deregisterStreamConsumer_consumerName - The name that you gave to the consumer.

data DeregisterStreamConsumerResponse Source #

See: newDeregisterStreamConsumerResponse smart constructor.

Constructors

DeregisterStreamConsumerResponse'

Instances

Instances details

Eq DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods (==) :: DeregisterStreamConsumerResponse -> DeregisterStreamConsumerResponse -> Bool # (/=) :: DeregisterStreamConsumerResponse -> DeregisterStreamConsumerResponse -> Bool #
Read DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods readsPrec :: Int -> ReadS DeregisterStreamConsumerResponse # readList :: ReadS [DeregisterStreamConsumerResponse] # readPrec :: ReadPrec DeregisterStreamConsumerResponse # readListPrec :: ReadPrec [DeregisterStreamConsumerResponse] #
Show DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods showsPrec :: Int -> DeregisterStreamConsumerResponse -> ShowS # show :: DeregisterStreamConsumerResponse -> String # showList :: [DeregisterStreamConsumerResponse] -> ShowS #
Generic DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Associated Types type Rep DeregisterStreamConsumerResponse :: Type -> Type # Methods from :: DeregisterStreamConsumerResponse -> Rep DeregisterStreamConsumerResponse x # to :: Rep DeregisterStreamConsumerResponse x -> DeregisterStreamConsumerResponse #
NFData DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods rnf :: DeregisterStreamConsumerResponse -> () #
type Rep DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer type Rep DeregisterStreamConsumerResponse = D1 ('MetaData "DeregisterStreamConsumerResponse" "Amazonka.Kinesis.DeregisterStreamConsumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DeregisterStreamConsumerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeregisterStreamConsumerResponse :: DeregisterStreamConsumerResponse Source #

Create a value of DeregisterStreamConsumerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DescribeStreamSummary

data DescribeStreamSummary Source #

See: newDescribeStreamSummary smart constructor.

Constructors

DescribeStreamSummary' Text

Instances

Instances details

Eq DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods (==) :: DescribeStreamSummary -> DescribeStreamSummary -> Bool # (/=) :: DescribeStreamSummary -> DescribeStreamSummary -> Bool #
Read DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods readsPrec :: Int -> ReadS DescribeStreamSummary # readList :: ReadS [DescribeStreamSummary] # readPrec :: ReadPrec DescribeStreamSummary # readListPrec :: ReadPrec [DescribeStreamSummary] #
Show DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods showsPrec :: Int -> DescribeStreamSummary -> ShowS # show :: DescribeStreamSummary -> String # showList :: [DescribeStreamSummary] -> ShowS #
Generic DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Associated Types type Rep DescribeStreamSummary :: Type -> Type # Methods from :: DescribeStreamSummary -> Rep DescribeStreamSummary x # to :: Rep DescribeStreamSummary x -> DescribeStreamSummary #
NFData DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods rnf :: DescribeStreamSummary -> () #
Hashable DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods hashWithSalt :: Int -> DescribeStreamSummary -> Int # hash :: DescribeStreamSummary -> Int #
ToJSON DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods toJSON :: DescribeStreamSummary -> Value # toEncoding :: DescribeStreamSummary -> Encoding # toJSONList :: [DescribeStreamSummary] -> Value # toEncodingList :: [DescribeStreamSummary] -> Encoding #
AWSRequest DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Associated Types type AWSResponse DescribeStreamSummary # Methods request :: DescribeStreamSummary -> Request DescribeStreamSummary # response :: MonadResource m => Logger -> Service -> Proxy DescribeStreamSummary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStreamSummary))) #
ToHeaders DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods toHeaders :: DescribeStreamSummary -> [Header] #
ToPath DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods toPath :: DescribeStreamSummary -> ByteString #
ToQuery DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods toQuery :: DescribeStreamSummary -> QueryString #
type Rep DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary type Rep DescribeStreamSummary = D1 ('MetaData "DescribeStreamSummary" "Amazonka.Kinesis.DescribeStreamSummary" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStreamSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeStreamSummary Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary type AWSResponse DescribeStreamSummary = DescribeStreamSummaryResponse

newDescribeStreamSummary Source #

Arguments

:: Text	`$sel:streamName:DescribeStreamSummary'`
-> DescribeStreamSummary

Create a value of DescribeStreamSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:DescribeStreamSummary', describeStreamSummary_streamName - The name of the stream to describe.

data DescribeStreamSummaryResponse Source #

See: newDescribeStreamSummaryResponse smart constructor.

Constructors

DescribeStreamSummaryResponse' Int StreamDescriptionSummary

Instances

Instances details

Eq DescribeStreamSummaryResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods (==) :: DescribeStreamSummaryResponse -> DescribeStreamSummaryResponse -> Bool # (/=) :: DescribeStreamSummaryResponse -> DescribeStreamSummaryResponse -> Bool #
Read DescribeStreamSummaryResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods readsPrec :: Int -> ReadS DescribeStreamSummaryResponse # readList :: ReadS [DescribeStreamSummaryResponse] # readPrec :: ReadPrec DescribeStreamSummaryResponse # readListPrec :: ReadPrec [DescribeStreamSummaryResponse] #
Show DescribeStreamSummaryResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods showsPrec :: Int -> DescribeStreamSummaryResponse -> ShowS # show :: DescribeStreamSummaryResponse -> String # showList :: [DescribeStreamSummaryResponse] -> ShowS #
Generic DescribeStreamSummaryResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Associated Types type Rep DescribeStreamSummaryResponse :: Type -> Type # Methods from :: DescribeStreamSummaryResponse -> Rep DescribeStreamSummaryResponse x # to :: Rep DescribeStreamSummaryResponse x -> DescribeStreamSummaryResponse #
NFData DescribeStreamSummaryResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary Methods rnf :: DescribeStreamSummaryResponse -> () #
type Rep DescribeStreamSummaryResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamSummary type Rep DescribeStreamSummaryResponse = D1 ('MetaData "DescribeStreamSummaryResponse" "Amazonka.Kinesis.DescribeStreamSummary" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStreamSummaryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "streamDescriptionSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamDescriptionSummary)))

newDescribeStreamSummaryResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeStreamSummaryResponse'`
-> StreamDescriptionSummary	`$sel:streamDescriptionSummary:DescribeStreamSummaryResponse'`
-> DescribeStreamSummaryResponse

Create a value of DescribeStreamSummaryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeStreamSummaryResponse', describeStreamSummaryResponse_httpStatus - The response's http status code.

$sel:streamDescriptionSummary:DescribeStreamSummaryResponse', describeStreamSummaryResponse_streamDescriptionSummary - A StreamDescriptionSummary containing information about the stream.

GetShardIterator

data GetShardIterator Source #

Represents the input for GetShardIterator.

See: newGetShardIterator smart constructor.

Constructors

GetShardIterator' (Maybe Text) (Maybe POSIX) Text Text ShardIteratorType

Instances

Instances details

Eq GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods (==) :: GetShardIterator -> GetShardIterator -> Bool # (/=) :: GetShardIterator -> GetShardIterator -> Bool #
Read GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods readsPrec :: Int -> ReadS GetShardIterator # readList :: ReadS [GetShardIterator] # readPrec :: ReadPrec GetShardIterator # readListPrec :: ReadPrec [GetShardIterator] #
Show GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods showsPrec :: Int -> GetShardIterator -> ShowS # show :: GetShardIterator -> String # showList :: [GetShardIterator] -> ShowS #
Generic GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Associated Types type Rep GetShardIterator :: Type -> Type # Methods from :: GetShardIterator -> Rep GetShardIterator x # to :: Rep GetShardIterator x -> GetShardIterator #
NFData GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods rnf :: GetShardIterator -> () #
Hashable GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods hashWithSalt :: Int -> GetShardIterator -> Int # hash :: GetShardIterator -> Int #
ToJSON GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods toJSON :: GetShardIterator -> Value # toEncoding :: GetShardIterator -> Encoding # toJSONList :: [GetShardIterator] -> Value # toEncodingList :: [GetShardIterator] -> Encoding #
AWSRequest GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Associated Types type AWSResponse GetShardIterator # Methods request :: GetShardIterator -> Request GetShardIterator # response :: MonadResource m => Logger -> Service -> Proxy GetShardIterator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetShardIterator))) #
ToHeaders GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods toHeaders :: GetShardIterator -> [Header] #
ToPath GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods toPath :: GetShardIterator -> ByteString #
ToQuery GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods toQuery :: GetShardIterator -> QueryString #
type Rep GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator type Rep GetShardIterator = D1 ('MetaData "GetShardIterator" "Amazonka.Kinesis.GetShardIterator" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "GetShardIterator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "startingSequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "shardIteratorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShardIteratorType)))))
type AWSResponse GetShardIterator Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator type AWSResponse GetShardIterator = GetShardIteratorResponse

newGetShardIterator Source #

Arguments

:: Text	`$sel:streamName:GetShardIterator'`
-> Text	`$sel:shardId:GetShardIterator'`
-> ShardIteratorType	`$sel:shardIteratorType:GetShardIterator'`
-> GetShardIterator

Create a value of GetShardIterator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:startingSequenceNumber:GetShardIterator', getShardIterator_startingSequenceNumber - The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

$sel:timestamp:GetShardIterator', getShardIterator_timestamp - The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

$sel:streamName:GetShardIterator', getShardIterator_streamName - The name of the Amazon Kinesis data stream.

$sel:shardId:GetShardIterator', getShardIterator_shardId - The shard ID of the Kinesis Data Streams shard to get the iterator for.

$sel:shardIteratorType:GetShardIterator', getShardIterator_shardIteratorType - Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.
AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

data GetShardIteratorResponse Source #

Represents the output for GetShardIterator.

See: newGetShardIteratorResponse smart constructor.

Constructors

GetShardIteratorResponse' (Maybe Text) Int

Instances

Instances details

Eq GetShardIteratorResponse Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods (==) :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool # (/=) :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool #
Read GetShardIteratorResponse Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods readsPrec :: Int -> ReadS GetShardIteratorResponse # readList :: ReadS [GetShardIteratorResponse] # readPrec :: ReadPrec GetShardIteratorResponse # readListPrec :: ReadPrec [GetShardIteratorResponse] #
Show GetShardIteratorResponse Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods showsPrec :: Int -> GetShardIteratorResponse -> ShowS # show :: GetShardIteratorResponse -> String # showList :: [GetShardIteratorResponse] -> ShowS #
Generic GetShardIteratorResponse Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Associated Types type Rep GetShardIteratorResponse :: Type -> Type # Methods from :: GetShardIteratorResponse -> Rep GetShardIteratorResponse x # to :: Rep GetShardIteratorResponse x -> GetShardIteratorResponse #
NFData GetShardIteratorResponse Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator Methods rnf :: GetShardIteratorResponse -> () #
type Rep GetShardIteratorResponse Source #
Instance details Defined in Amazonka.Kinesis.GetShardIterator type Rep GetShardIteratorResponse = D1 ('MetaData "GetShardIteratorResponse" "Amazonka.Kinesis.GetShardIterator" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "GetShardIteratorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shardIterator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetShardIteratorResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetShardIteratorResponse'`
-> GetShardIteratorResponse

Create a value of GetShardIteratorResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shardIterator:GetShardIteratorResponse', getShardIteratorResponse_shardIterator - The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

$sel:httpStatus:GetShardIteratorResponse', getShardIteratorResponse_httpStatus - The response's http status code.

GetRecords

data GetRecords Source #

Represents the input for GetRecords.

See: newGetRecords smart constructor.

Constructors

GetRecords' (Maybe Natural) Text

Instances

Instances details

Eq GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods (==) :: GetRecords -> GetRecords -> Bool # (/=) :: GetRecords -> GetRecords -> Bool #
Read GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods readsPrec :: Int -> ReadS GetRecords # readList :: ReadS [GetRecords] # readPrec :: ReadPrec GetRecords # readListPrec :: ReadPrec [GetRecords] #
Show GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods showsPrec :: Int -> GetRecords -> ShowS # show :: GetRecords -> String # showList :: [GetRecords] -> ShowS #
Generic GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Associated Types type Rep GetRecords :: Type -> Type # Methods from :: GetRecords -> Rep GetRecords x # to :: Rep GetRecords x -> GetRecords #
NFData GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods rnf :: GetRecords -> () #
Hashable GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods hashWithSalt :: Int -> GetRecords -> Int # hash :: GetRecords -> Int #
ToJSON GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods toJSON :: GetRecords -> Value # toEncoding :: GetRecords -> Encoding # toJSONList :: [GetRecords] -> Value # toEncodingList :: [GetRecords] -> Encoding #
AWSRequest GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Associated Types type AWSResponse GetRecords # Methods request :: GetRecords -> Request GetRecords # response :: MonadResource m => Logger -> Service -> Proxy GetRecords -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRecords))) #
ToHeaders GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods toHeaders :: GetRecords -> [Header] #
ToPath GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods toPath :: GetRecords -> ByteString #
ToQuery GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods toQuery :: GetRecords -> QueryString #
type Rep GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords type Rep GetRecords = D1 ('MetaData "GetRecords" "Amazonka.Kinesis.GetRecords" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "GetRecords'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "shardIterator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetRecords Source #
Instance details Defined in Amazonka.Kinesis.GetRecords type AWSResponse GetRecords = GetRecordsResponse

newGetRecords Source #

Arguments

:: Text	`$sel:shardIterator:GetRecords'`
-> GetRecords

Create a value of GetRecords with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:GetRecords', getRecords_limit - The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.

$sel:shardIterator:GetRecords', getRecords_shardIterator - The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

data GetRecordsResponse Source #

Represents the output for GetRecords.

See: newGetRecordsResponse smart constructor.

Constructors

GetRecordsResponse' (Maybe Text) (Maybe Natural) (Maybe [ChildShard]) Int [Record]

Instances

Instances details

Eq GetRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods (==) :: GetRecordsResponse -> GetRecordsResponse -> Bool # (/=) :: GetRecordsResponse -> GetRecordsResponse -> Bool #
Read GetRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods readsPrec :: Int -> ReadS GetRecordsResponse # readList :: ReadS [GetRecordsResponse] # readPrec :: ReadPrec GetRecordsResponse # readListPrec :: ReadPrec [GetRecordsResponse] #
Show GetRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods showsPrec :: Int -> GetRecordsResponse -> ShowS # show :: GetRecordsResponse -> String # showList :: [GetRecordsResponse] -> ShowS #
Generic GetRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Associated Types type Rep GetRecordsResponse :: Type -> Type # Methods from :: GetRecordsResponse -> Rep GetRecordsResponse x # to :: Rep GetRecordsResponse x -> GetRecordsResponse #
NFData GetRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.GetRecords Methods rnf :: GetRecordsResponse -> () #
type Rep GetRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.GetRecords type Rep GetRecordsResponse = D1 ('MetaData "GetRecordsResponse" "Amazonka.Kinesis.GetRecords" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "GetRecordsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextShardIterator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "millisBehindLatest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "childShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChildShard])) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Record])))))

newGetRecordsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRecordsResponse'`
-> GetRecordsResponse

Create a value of GetRecordsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextShardIterator:GetRecordsResponse', getRecordsResponse_nextShardIterator - The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

$sel:millisBehindLatest:GetRecordsResponse', getRecordsResponse_millisBehindLatest - The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

$sel:childShards:GetRecordsResponse', getRecordsResponse_childShards - Undocumented member.

$sel:httpStatus:GetRecordsResponse', getRecordsResponse_httpStatus - The response's http status code.

$sel:records:GetRecordsResponse', getRecordsResponse_records - The data records retrieved from the shard.

StopStreamEncryption

data StopStreamEncryption Source #

See: newStopStreamEncryption smart constructor.

Constructors

StopStreamEncryption' Text EncryptionType Text

Instances

Instances details

Eq StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods (==) :: StopStreamEncryption -> StopStreamEncryption -> Bool # (/=) :: StopStreamEncryption -> StopStreamEncryption -> Bool #
Read StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods readsPrec :: Int -> ReadS StopStreamEncryption # readList :: ReadS [StopStreamEncryption] # readPrec :: ReadPrec StopStreamEncryption # readListPrec :: ReadPrec [StopStreamEncryption] #
Show StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods showsPrec :: Int -> StopStreamEncryption -> ShowS # show :: StopStreamEncryption -> String # showList :: [StopStreamEncryption] -> ShowS #
Generic StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Associated Types type Rep StopStreamEncryption :: Type -> Type # Methods from :: StopStreamEncryption -> Rep StopStreamEncryption x # to :: Rep StopStreamEncryption x -> StopStreamEncryption #
NFData StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods rnf :: StopStreamEncryption -> () #
Hashable StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods hashWithSalt :: Int -> StopStreamEncryption -> Int # hash :: StopStreamEncryption -> Int #
ToJSON StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods toJSON :: StopStreamEncryption -> Value # toEncoding :: StopStreamEncryption -> Encoding # toJSONList :: [StopStreamEncryption] -> Value # toEncodingList :: [StopStreamEncryption] -> Encoding #
AWSRequest StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Associated Types type AWSResponse StopStreamEncryption # Methods request :: StopStreamEncryption -> Request StopStreamEncryption # response :: MonadResource m => Logger -> Service -> Proxy StopStreamEncryption -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopStreamEncryption))) #
ToHeaders StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods toHeaders :: StopStreamEncryption -> [Header] #
ToPath StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods toPath :: StopStreamEncryption -> ByteString #
ToQuery StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods toQuery :: StopStreamEncryption -> QueryString #
type Rep StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption type Rep StopStreamEncryption = D1 ('MetaData "StopStreamEncryption" "Amazonka.Kinesis.StopStreamEncryption" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StopStreamEncryption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionType) :: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StopStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption type AWSResponse StopStreamEncryption = StopStreamEncryptionResponse

newStopStreamEncryption Source #

Arguments

:: Text	`$sel:streamName:StopStreamEncryption'`
-> EncryptionType	`$sel:encryptionType:StopStreamEncryption'`
-> Text	`$sel:keyId:StopStreamEncryption'`
-> StopStreamEncryption

Create a value of StopStreamEncryption with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:StopStreamEncryption', stopStreamEncryption_streamName - The name of the stream on which to stop encrypting records.

$sel:encryptionType:StopStreamEncryption', stopStreamEncryption_encryptionType - The encryption type. The only valid value is KMS.

$sel:keyId:StopStreamEncryption', stopStreamEncryption_keyId - 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/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis

data StopStreamEncryptionResponse Source #

See: newStopStreamEncryptionResponse smart constructor.

Constructors

StopStreamEncryptionResponse'

Instances

Instances details

Eq StopStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods (==) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool # (/=) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool #
Read StopStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods readsPrec :: Int -> ReadS StopStreamEncryptionResponse # readList :: ReadS [StopStreamEncryptionResponse] # readPrec :: ReadPrec StopStreamEncryptionResponse # readListPrec :: ReadPrec [StopStreamEncryptionResponse] #
Show StopStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods showsPrec :: Int -> StopStreamEncryptionResponse -> ShowS # show :: StopStreamEncryptionResponse -> String # showList :: [StopStreamEncryptionResponse] -> ShowS #
Generic StopStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Associated Types type Rep StopStreamEncryptionResponse :: Type -> Type # Methods from :: StopStreamEncryptionResponse -> Rep StopStreamEncryptionResponse x # to :: Rep StopStreamEncryptionResponse x -> StopStreamEncryptionResponse #
NFData StopStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption Methods rnf :: StopStreamEncryptionResponse -> () #
type Rep StopStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StopStreamEncryption type Rep StopStreamEncryptionResponse = D1 ('MetaData "StopStreamEncryptionResponse" "Amazonka.Kinesis.StopStreamEncryption" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StopStreamEncryptionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopStreamEncryptionResponse :: StopStreamEncryptionResponse Source #

Create a value of StopStreamEncryptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

EnableEnhancedMonitoring

data EnableEnhancedMonitoring Source #

Represents the input for EnableEnhancedMonitoring.

See: newEnableEnhancedMonitoring smart constructor.

Constructors

EnableEnhancedMonitoring' Text [MetricsName]

Instances

Instances details

Eq EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods (==) :: EnableEnhancedMonitoring -> EnableEnhancedMonitoring -> Bool # (/=) :: EnableEnhancedMonitoring -> EnableEnhancedMonitoring -> Bool #
Read EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods readsPrec :: Int -> ReadS EnableEnhancedMonitoring # readList :: ReadS [EnableEnhancedMonitoring] # readPrec :: ReadPrec EnableEnhancedMonitoring # readListPrec :: ReadPrec [EnableEnhancedMonitoring] #
Show EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods showsPrec :: Int -> EnableEnhancedMonitoring -> ShowS # show :: EnableEnhancedMonitoring -> String # showList :: [EnableEnhancedMonitoring] -> ShowS #
Generic EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Associated Types type Rep EnableEnhancedMonitoring :: Type -> Type # Methods from :: EnableEnhancedMonitoring -> Rep EnableEnhancedMonitoring x # to :: Rep EnableEnhancedMonitoring x -> EnableEnhancedMonitoring #
NFData EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods rnf :: EnableEnhancedMonitoring -> () #
Hashable EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods hashWithSalt :: Int -> EnableEnhancedMonitoring -> Int # hash :: EnableEnhancedMonitoring -> Int #
ToJSON EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods toJSON :: EnableEnhancedMonitoring -> Value # toEncoding :: EnableEnhancedMonitoring -> Encoding # toJSONList :: [EnableEnhancedMonitoring] -> Value # toEncodingList :: [EnableEnhancedMonitoring] -> Encoding #
AWSRequest EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Associated Types type AWSResponse EnableEnhancedMonitoring # Methods request :: EnableEnhancedMonitoring -> Request EnableEnhancedMonitoring # response :: MonadResource m => Logger -> Service -> Proxy EnableEnhancedMonitoring -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableEnhancedMonitoring))) #
ToHeaders EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods toHeaders :: EnableEnhancedMonitoring -> [Header] #
ToPath EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods toPath :: EnableEnhancedMonitoring -> ByteString #
ToQuery EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring Methods toQuery :: EnableEnhancedMonitoring -> QueryString #
type Rep EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring type Rep EnableEnhancedMonitoring = D1 ('MetaData "EnableEnhancedMonitoring" "Amazonka.Kinesis.EnableEnhancedMonitoring" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "EnableEnhancedMonitoring'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MetricsName])))
type AWSResponse EnableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.EnableEnhancedMonitoring type AWSResponse EnableEnhancedMonitoring = EnhancedMonitoringOutput

newEnableEnhancedMonitoring Source #

Arguments

:: Text	`$sel:streamName:EnableEnhancedMonitoring'`
-> EnableEnhancedMonitoring

Create a value of EnableEnhancedMonitoring with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:EnableEnhancedMonitoring', enableEnhancedMonitoring_streamName - The name of the stream for which to enable enhanced monitoring.

$sel:shardLevelMetrics:EnableEnhancedMonitoring', enableEnhancedMonitoring_shardLevelMetrics - List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value "ALL" enables every metric.

```
IncomingBytes
```
```
IncomingRecords
```
```
OutgoingBytes
```
```
OutgoingRecords
```
```
WriteProvisionedThroughputExceeded
```
```
ReadProvisionedThroughputExceeded
```
```
IteratorAgeMilliseconds
```
```
ALL
```

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

data EnhancedMonitoringOutput Source #

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

See: newEnhancedMonitoringOutput smart constructor.

Constructors

EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text)

Instances

Instances details

Eq EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods (==) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool # (/=) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool #
Read EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods readsPrec :: Int -> ReadS EnhancedMonitoringOutput # readList :: ReadS [EnhancedMonitoringOutput] # readPrec :: ReadPrec EnhancedMonitoringOutput # readListPrec :: ReadPrec [EnhancedMonitoringOutput] #
Show EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods showsPrec :: Int -> EnhancedMonitoringOutput -> ShowS # show :: EnhancedMonitoringOutput -> String # showList :: [EnhancedMonitoringOutput] -> ShowS #
Generic EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Associated Types type Rep EnhancedMonitoringOutput :: Type -> Type # Methods from :: EnhancedMonitoringOutput -> Rep EnhancedMonitoringOutput x # to :: Rep EnhancedMonitoringOutput x -> EnhancedMonitoringOutput #
NFData EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods rnf :: EnhancedMonitoringOutput -> () #
Hashable EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods hashWithSalt :: Int -> EnhancedMonitoringOutput -> Int # hash :: EnhancedMonitoringOutput -> Int #
FromJSON EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods parseJSON :: Value -> Parser EnhancedMonitoringOutput # parseJSONList :: Value -> Parser [EnhancedMonitoringOutput] #
type Rep EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput type Rep EnhancedMonitoringOutput = D1 ('MetaData "EnhancedMonitoringOutput" "Amazonka.Kinesis.Types.EnhancedMonitoringOutput" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "EnhancedMonitoringOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "desiredShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: (S1 ('MetaSel ('Just "currentShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEnhancedMonitoringOutput :: EnhancedMonitoringOutput Source #

Create a value of EnhancedMonitoringOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:desiredShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_desiredShardLevelMetrics - Represents the list of all the metrics that would be in the enhanced state after the operation.

$sel:currentShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_currentShardLevelMetrics - Represents the current state of the metrics that are in the enhanced state before the operation.

$sel:streamName:EnhancedMonitoringOutput', enhancedMonitoringOutput_streamName - The name of the Kinesis data stream.

DescribeLimits

data DescribeLimits Source #

See: newDescribeLimits smart constructor.

Constructors

DescribeLimits'

Instances

Instances details

Eq DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods (==) :: DescribeLimits -> DescribeLimits -> Bool # (/=) :: DescribeLimits -> DescribeLimits -> Bool #
Read DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods readsPrec :: Int -> ReadS DescribeLimits # readList :: ReadS [DescribeLimits] # readPrec :: ReadPrec DescribeLimits # readListPrec :: ReadPrec [DescribeLimits] #
Show DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods showsPrec :: Int -> DescribeLimits -> ShowS # show :: DescribeLimits -> String # showList :: [DescribeLimits] -> ShowS #
Generic DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Associated Types type Rep DescribeLimits :: Type -> Type # Methods from :: DescribeLimits -> Rep DescribeLimits x # to :: Rep DescribeLimits x -> DescribeLimits #
NFData DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods rnf :: DescribeLimits -> () #
Hashable DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods hashWithSalt :: Int -> DescribeLimits -> Int # hash :: DescribeLimits -> Int #
ToJSON DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods toJSON :: DescribeLimits -> Value # toEncoding :: DescribeLimits -> Encoding # toJSONList :: [DescribeLimits] -> Value # toEncodingList :: [DescribeLimits] -> Encoding #
AWSRequest DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Associated Types type AWSResponse DescribeLimits # Methods request :: DescribeLimits -> Request DescribeLimits # response :: MonadResource m => Logger -> Service -> Proxy DescribeLimits -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeLimits))) #
ToHeaders DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods toHeaders :: DescribeLimits -> [Header] #
ToPath DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods toPath :: DescribeLimits -> ByteString #
ToQuery DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods toQuery :: DescribeLimits -> QueryString #
type Rep DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits type Rep DescribeLimits = D1 ('MetaData "DescribeLimits" "Amazonka.Kinesis.DescribeLimits" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeLimits'" 'PrefixI 'False) (U1 :: Type -> Type))
type AWSResponse DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits type AWSResponse DescribeLimits = DescribeLimitsResponse

newDescribeLimits :: DescribeLimits Source #

Create a value of DescribeLimits with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

data DescribeLimitsResponse Source #

See: newDescribeLimitsResponse smart constructor.

Constructors

DescribeLimitsResponse' Int Natural Natural

Instances

Instances details

Eq DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods (==) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool # (/=) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool #
Read DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods readsPrec :: Int -> ReadS DescribeLimitsResponse # readList :: ReadS [DescribeLimitsResponse] # readPrec :: ReadPrec DescribeLimitsResponse # readListPrec :: ReadPrec [DescribeLimitsResponse] #
Show DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods showsPrec :: Int -> DescribeLimitsResponse -> ShowS # show :: DescribeLimitsResponse -> String # showList :: [DescribeLimitsResponse] -> ShowS #
Generic DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Associated Types type Rep DescribeLimitsResponse :: Type -> Type # Methods from :: DescribeLimitsResponse -> Rep DescribeLimitsResponse x # to :: Rep DescribeLimitsResponse x -> DescribeLimitsResponse #
NFData DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods rnf :: DescribeLimitsResponse -> () #
type Rep DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits type Rep DescribeLimitsResponse = D1 ('MetaData "DescribeLimitsResponse" "Amazonka.Kinesis.DescribeLimits" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeLimitsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "shardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "openShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newDescribeLimitsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeLimitsResponse'`
-> Natural	`$sel:shardLimit:DescribeLimitsResponse'`
-> Natural	`$sel:openShardCount:DescribeLimitsResponse'`
-> DescribeLimitsResponse

Create a value of DescribeLimitsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeLimitsResponse', describeLimitsResponse_httpStatus - The response's http status code.

$sel:shardLimit:DescribeLimitsResponse', describeLimitsResponse_shardLimit - The maximum number of shards.

$sel:openShardCount:DescribeLimitsResponse', describeLimitsResponse_openShardCount - The number of open shards.

RegisterStreamConsumer

data RegisterStreamConsumer Source #

See: newRegisterStreamConsumer smart constructor.

Constructors

RegisterStreamConsumer' Text Text

Instances

Instances details

Eq RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods (==) :: RegisterStreamConsumer -> RegisterStreamConsumer -> Bool # (/=) :: RegisterStreamConsumer -> RegisterStreamConsumer -> Bool #
Read RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods readsPrec :: Int -> ReadS RegisterStreamConsumer # readList :: ReadS [RegisterStreamConsumer] # readPrec :: ReadPrec RegisterStreamConsumer # readListPrec :: ReadPrec [RegisterStreamConsumer] #
Show RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods showsPrec :: Int -> RegisterStreamConsumer -> ShowS # show :: RegisterStreamConsumer -> String # showList :: [RegisterStreamConsumer] -> ShowS #
Generic RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Associated Types type Rep RegisterStreamConsumer :: Type -> Type # Methods from :: RegisterStreamConsumer -> Rep RegisterStreamConsumer x # to :: Rep RegisterStreamConsumer x -> RegisterStreamConsumer #
NFData RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods rnf :: RegisterStreamConsumer -> () #
Hashable RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods hashWithSalt :: Int -> RegisterStreamConsumer -> Int # hash :: RegisterStreamConsumer -> Int #
ToJSON RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods toJSON :: RegisterStreamConsumer -> Value # toEncoding :: RegisterStreamConsumer -> Encoding # toJSONList :: [RegisterStreamConsumer] -> Value # toEncodingList :: [RegisterStreamConsumer] -> Encoding #
AWSRequest RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Associated Types type AWSResponse RegisterStreamConsumer # Methods request :: RegisterStreamConsumer -> Request RegisterStreamConsumer # response :: MonadResource m => Logger -> Service -> Proxy RegisterStreamConsumer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterStreamConsumer))) #
ToHeaders RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods toHeaders :: RegisterStreamConsumer -> [Header] #
ToPath RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods toPath :: RegisterStreamConsumer -> ByteString #
ToQuery RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods toQuery :: RegisterStreamConsumer -> QueryString #
type Rep RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer type Rep RegisterStreamConsumer = D1 ('MetaData "RegisterStreamConsumer" "Amazonka.Kinesis.RegisterStreamConsumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "RegisterStreamConsumer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse RegisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer type AWSResponse RegisterStreamConsumer = RegisterStreamConsumerResponse

newRegisterStreamConsumer Source #

Arguments

:: Text	`$sel:streamARN:RegisterStreamConsumer'`
-> Text	`$sel:consumerName:RegisterStreamConsumer'`
-> RegisterStreamConsumer

Create a value of RegisterStreamConsumer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamARN:RegisterStreamConsumer', registerStreamConsumer_streamARN - The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

$sel:consumerName:RegisterStreamConsumer', registerStreamConsumer_consumerName - For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

data RegisterStreamConsumerResponse Source #

See: newRegisterStreamConsumerResponse smart constructor.

Constructors

RegisterStreamConsumerResponse' Int Consumer

Instances

Instances details

Eq RegisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods (==) :: RegisterStreamConsumerResponse -> RegisterStreamConsumerResponse -> Bool # (/=) :: RegisterStreamConsumerResponse -> RegisterStreamConsumerResponse -> Bool #
Read RegisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods readsPrec :: Int -> ReadS RegisterStreamConsumerResponse # readList :: ReadS [RegisterStreamConsumerResponse] # readPrec :: ReadPrec RegisterStreamConsumerResponse # readListPrec :: ReadPrec [RegisterStreamConsumerResponse] #
Show RegisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods showsPrec :: Int -> RegisterStreamConsumerResponse -> ShowS # show :: RegisterStreamConsumerResponse -> String # showList :: [RegisterStreamConsumerResponse] -> ShowS #
Generic RegisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Associated Types type Rep RegisterStreamConsumerResponse :: Type -> Type # Methods from :: RegisterStreamConsumerResponse -> Rep RegisterStreamConsumerResponse x # to :: Rep RegisterStreamConsumerResponse x -> RegisterStreamConsumerResponse #
NFData RegisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer Methods rnf :: RegisterStreamConsumerResponse -> () #
type Rep RegisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.RegisterStreamConsumer type Rep RegisterStreamConsumerResponse = D1 ('MetaData "RegisterStreamConsumerResponse" "Amazonka.Kinesis.RegisterStreamConsumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "RegisterStreamConsumerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "consumer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Consumer)))

newRegisterStreamConsumerResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterStreamConsumerResponse'`
-> Consumer	`$sel:consumer:RegisterStreamConsumerResponse'`
-> RegisterStreamConsumerResponse

Create a value of RegisterStreamConsumerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:RegisterStreamConsumerResponse', registerStreamConsumerResponse_httpStatus - The response's http status code.

$sel:consumer:RegisterStreamConsumerResponse', registerStreamConsumerResponse_consumer - An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.

DisableEnhancedMonitoring

data DisableEnhancedMonitoring Source #

Represents the input for DisableEnhancedMonitoring.

See: newDisableEnhancedMonitoring smart constructor.

Constructors

DisableEnhancedMonitoring' Text [MetricsName]

Instances

Instances details

Eq DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods (==) :: DisableEnhancedMonitoring -> DisableEnhancedMonitoring -> Bool # (/=) :: DisableEnhancedMonitoring -> DisableEnhancedMonitoring -> Bool #
Read DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods readsPrec :: Int -> ReadS DisableEnhancedMonitoring # readList :: ReadS [DisableEnhancedMonitoring] # readPrec :: ReadPrec DisableEnhancedMonitoring # readListPrec :: ReadPrec [DisableEnhancedMonitoring] #
Show DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods showsPrec :: Int -> DisableEnhancedMonitoring -> ShowS # show :: DisableEnhancedMonitoring -> String # showList :: [DisableEnhancedMonitoring] -> ShowS #
Generic DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Associated Types type Rep DisableEnhancedMonitoring :: Type -> Type # Methods from :: DisableEnhancedMonitoring -> Rep DisableEnhancedMonitoring x # to :: Rep DisableEnhancedMonitoring x -> DisableEnhancedMonitoring #
NFData DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods rnf :: DisableEnhancedMonitoring -> () #
Hashable DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods hashWithSalt :: Int -> DisableEnhancedMonitoring -> Int # hash :: DisableEnhancedMonitoring -> Int #
ToJSON DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods toJSON :: DisableEnhancedMonitoring -> Value # toEncoding :: DisableEnhancedMonitoring -> Encoding # toJSONList :: [DisableEnhancedMonitoring] -> Value # toEncodingList :: [DisableEnhancedMonitoring] -> Encoding #
AWSRequest DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Associated Types type AWSResponse DisableEnhancedMonitoring # Methods request :: DisableEnhancedMonitoring -> Request DisableEnhancedMonitoring # response :: MonadResource m => Logger -> Service -> Proxy DisableEnhancedMonitoring -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisableEnhancedMonitoring))) #
ToHeaders DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods toHeaders :: DisableEnhancedMonitoring -> [Header] #
ToPath DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods toPath :: DisableEnhancedMonitoring -> ByteString #
ToQuery DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring Methods toQuery :: DisableEnhancedMonitoring -> QueryString #
type Rep DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring type Rep DisableEnhancedMonitoring = D1 ('MetaData "DisableEnhancedMonitoring" "Amazonka.Kinesis.DisableEnhancedMonitoring" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DisableEnhancedMonitoring'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MetricsName])))
type AWSResponse DisableEnhancedMonitoring Source #
Instance details Defined in Amazonka.Kinesis.DisableEnhancedMonitoring type AWSResponse DisableEnhancedMonitoring = EnhancedMonitoringOutput

newDisableEnhancedMonitoring Source #

Arguments

:: Text	`$sel:streamName:DisableEnhancedMonitoring'`
-> DisableEnhancedMonitoring

Create a value of DisableEnhancedMonitoring with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:DisableEnhancedMonitoring', disableEnhancedMonitoring_streamName - The name of the Kinesis data stream for which to disable enhanced monitoring.

$sel:shardLevelMetrics:DisableEnhancedMonitoring', disableEnhancedMonitoring_shardLevelMetrics - List of shard-level metrics to disable.

The following are the valid shard-level metrics. The value "ALL" disables every metric.

```
IncomingBytes
```
```
IncomingRecords
```
```
OutgoingBytes
```
```
OutgoingRecords
```
```
WriteProvisionedThroughputExceeded
```
```
ReadProvisionedThroughputExceeded
```
```
IteratorAgeMilliseconds
```
```
ALL
```

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

data EnhancedMonitoringOutput Source #

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

See: newEnhancedMonitoringOutput smart constructor.

Constructors

EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text)

Instances

Instances details

Eq EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods (==) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool # (/=) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool #
Read EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods readsPrec :: Int -> ReadS EnhancedMonitoringOutput # readList :: ReadS [EnhancedMonitoringOutput] # readPrec :: ReadPrec EnhancedMonitoringOutput # readListPrec :: ReadPrec [EnhancedMonitoringOutput] #
Show EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods showsPrec :: Int -> EnhancedMonitoringOutput -> ShowS # show :: EnhancedMonitoringOutput -> String # showList :: [EnhancedMonitoringOutput] -> ShowS #
Generic EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Associated Types type Rep EnhancedMonitoringOutput :: Type -> Type # Methods from :: EnhancedMonitoringOutput -> Rep EnhancedMonitoringOutput x # to :: Rep EnhancedMonitoringOutput x -> EnhancedMonitoringOutput #
NFData EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods rnf :: EnhancedMonitoringOutput -> () #
Hashable EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods hashWithSalt :: Int -> EnhancedMonitoringOutput -> Int # hash :: EnhancedMonitoringOutput -> Int #
FromJSON EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods parseJSON :: Value -> Parser EnhancedMonitoringOutput # parseJSONList :: Value -> Parser [EnhancedMonitoringOutput] #
type Rep EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput type Rep EnhancedMonitoringOutput = D1 ('MetaData "EnhancedMonitoringOutput" "Amazonka.Kinesis.Types.EnhancedMonitoringOutput" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "EnhancedMonitoringOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "desiredShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: (S1 ('MetaSel ('Just "currentShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEnhancedMonitoringOutput :: EnhancedMonitoringOutput Source #

Create a value of EnhancedMonitoringOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:desiredShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_desiredShardLevelMetrics - Represents the list of all the metrics that would be in the enhanced state after the operation.

$sel:currentShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_currentShardLevelMetrics - Represents the current state of the metrics that are in the enhanced state before the operation.

$sel:streamName:EnhancedMonitoringOutput', enhancedMonitoringOutput_streamName - The name of the Kinesis data stream.

UpdateShardCount

data UpdateShardCount Source #

See: newUpdateShardCount smart constructor.

Constructors

UpdateShardCount' Text Natural ScalingType

Instances

Instances details

Eq UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods (==) :: UpdateShardCount -> UpdateShardCount -> Bool # (/=) :: UpdateShardCount -> UpdateShardCount -> Bool #
Read UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods readsPrec :: Int -> ReadS UpdateShardCount # readList :: ReadS [UpdateShardCount] # readPrec :: ReadPrec UpdateShardCount # readListPrec :: ReadPrec [UpdateShardCount] #
Show UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods showsPrec :: Int -> UpdateShardCount -> ShowS # show :: UpdateShardCount -> String # showList :: [UpdateShardCount] -> ShowS #
Generic UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Associated Types type Rep UpdateShardCount :: Type -> Type # Methods from :: UpdateShardCount -> Rep UpdateShardCount x # to :: Rep UpdateShardCount x -> UpdateShardCount #
NFData UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods rnf :: UpdateShardCount -> () #
Hashable UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods hashWithSalt :: Int -> UpdateShardCount -> Int # hash :: UpdateShardCount -> Int #
ToJSON UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toJSON :: UpdateShardCount -> Value # toEncoding :: UpdateShardCount -> Encoding # toJSONList :: [UpdateShardCount] -> Value # toEncodingList :: [UpdateShardCount] -> Encoding #
AWSRequest UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Associated Types type AWSResponse UpdateShardCount # Methods request :: UpdateShardCount -> Request UpdateShardCount # response :: MonadResource m => Logger -> Service -> Proxy UpdateShardCount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateShardCount))) #
ToHeaders UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toHeaders :: UpdateShardCount -> [Header] #
ToPath UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toPath :: UpdateShardCount -> ByteString #
ToQuery UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toQuery :: UpdateShardCount -> QueryString #
type Rep UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount type Rep UpdateShardCount = D1 ('MetaData "UpdateShardCount" "Amazonka.Kinesis.UpdateShardCount" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "UpdateShardCount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "targetShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "scalingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalingType))))
type AWSResponse UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount type AWSResponse UpdateShardCount = UpdateShardCountResponse

newUpdateShardCount Source #

Arguments

:: Text	`$sel:streamName:UpdateShardCount'`
-> Natural	`$sel:targetShardCount:UpdateShardCount'`
-> ScalingType	`$sel:scalingType:UpdateShardCount'`
-> UpdateShardCount

Create a value of UpdateShardCount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:UpdateShardCount', updateShardCount_streamName - The name of the stream.

$sel:targetShardCount:UpdateShardCount', updateShardCount_targetShardCount - The new number of shards. This value has the following default limits. By default, you cannot do the following:

Set this value to more than double your current shard count for a stream.
Set this value below half your current shard count for a stream.
Set this value to more than 500 shards in a stream (the default limit for shard count per stream is 500 per account per region), unless you request a limit increase.
Scale a stream with more than 500 shards down unless you set this value to less than 500 shards.

$sel:scalingType:UpdateShardCount', updateShardCount_scalingType - The scaling type. Uniform scaling creates shards of equal size.

data UpdateShardCountResponse Source #

See: newUpdateShardCountResponse smart constructor.

Constructors

UpdateShardCountResponse' (Maybe Natural) (Maybe Text) (Maybe Natural) Int

Instances

Instances details

Eq UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods (==) :: UpdateShardCountResponse -> UpdateShardCountResponse -> Bool # (/=) :: UpdateShardCountResponse -> UpdateShardCountResponse -> Bool #
Read UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods readsPrec :: Int -> ReadS UpdateShardCountResponse # readList :: ReadS [UpdateShardCountResponse] # readPrec :: ReadPrec UpdateShardCountResponse # readListPrec :: ReadPrec [UpdateShardCountResponse] #
Show UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods showsPrec :: Int -> UpdateShardCountResponse -> ShowS # show :: UpdateShardCountResponse -> String # showList :: [UpdateShardCountResponse] -> ShowS #
Generic UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Associated Types type Rep UpdateShardCountResponse :: Type -> Type # Methods from :: UpdateShardCountResponse -> Rep UpdateShardCountResponse x # to :: Rep UpdateShardCountResponse x -> UpdateShardCountResponse #
NFData UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods rnf :: UpdateShardCountResponse -> () #
type Rep UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount type Rep UpdateShardCountResponse = D1 ('MetaData "UpdateShardCountResponse" "Amazonka.Kinesis.UpdateShardCount" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "UpdateShardCountResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "targetShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "currentShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateShardCountResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateShardCountResponse'`
-> UpdateShardCountResponse

Create a value of UpdateShardCountResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:targetShardCount:UpdateShardCount', updateShardCountResponse_targetShardCount - The updated number of shards.

$sel:streamName:UpdateShardCount', updateShardCountResponse_streamName - The name of the stream.

$sel:currentShardCount:UpdateShardCountResponse', updateShardCountResponse_currentShardCount - The current number of shards.

$sel:httpStatus:UpdateShardCountResponse', updateShardCountResponse_httpStatus - The response's http status code.

ListTagsForStream

data ListTagsForStream Source #

Represents the input for ListTagsForStream.

See: newListTagsForStream smart constructor.

Constructors

ListTagsForStream' (Maybe Natural) (Maybe Text) Text

Instances

Instances details

Eq ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods (==) :: ListTagsForStream -> ListTagsForStream -> Bool # (/=) :: ListTagsForStream -> ListTagsForStream -> Bool #
Read ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods readsPrec :: Int -> ReadS ListTagsForStream # readList :: ReadS [ListTagsForStream] # readPrec :: ReadPrec ListTagsForStream # readListPrec :: ReadPrec [ListTagsForStream] #
Show ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods showsPrec :: Int -> ListTagsForStream -> ShowS # show :: ListTagsForStream -> String # showList :: [ListTagsForStream] -> ShowS #
Generic ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Associated Types type Rep ListTagsForStream :: Type -> Type # Methods from :: ListTagsForStream -> Rep ListTagsForStream x # to :: Rep ListTagsForStream x -> ListTagsForStream #
NFData ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods rnf :: ListTagsForStream -> () #
Hashable ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods hashWithSalt :: Int -> ListTagsForStream -> Int # hash :: ListTagsForStream -> Int #
ToJSON ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toJSON :: ListTagsForStream -> Value # toEncoding :: ListTagsForStream -> Encoding # toJSONList :: [ListTagsForStream] -> Value # toEncodingList :: [ListTagsForStream] -> Encoding #
AWSRequest ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Associated Types type AWSResponse ListTagsForStream # Methods request :: ListTagsForStream -> Request ListTagsForStream # response :: MonadResource m => Logger -> Service -> Proxy ListTagsForStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTagsForStream))) #
ToHeaders ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toHeaders :: ListTagsForStream -> [Header] #
ToPath ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toPath :: ListTagsForStream -> ByteString #
ToQuery ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toQuery :: ListTagsForStream -> QueryString #
type Rep ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream type Rep ListTagsForStream = D1 ('MetaData "ListTagsForStream" "Amazonka.Kinesis.ListTagsForStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListTagsForStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "exclusiveStartTagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream type AWSResponse ListTagsForStream = ListTagsForStreamResponse

newListTagsForStream Source #

Arguments

:: Text	`$sel:streamName:ListTagsForStream'`
-> ListTagsForStream

Create a value of ListTagsForStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListTagsForStream', listTagsForStream_limit - The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

$sel:exclusiveStartTagKey:ListTagsForStream', listTagsForStream_exclusiveStartTagKey - The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

$sel:streamName:ListTagsForStream', listTagsForStream_streamName - The name of the stream.

data ListTagsForStreamResponse Source #

Represents the output for ListTagsForStream.

See: newListTagsForStreamResponse smart constructor.

Constructors

ListTagsForStreamResponse' Int [Tag] Bool

Instances

Instances details

Eq ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods (==) :: ListTagsForStreamResponse -> ListTagsForStreamResponse -> Bool # (/=) :: ListTagsForStreamResponse -> ListTagsForStreamResponse -> Bool #
Read ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods readsPrec :: Int -> ReadS ListTagsForStreamResponse # readList :: ReadS [ListTagsForStreamResponse] # readPrec :: ReadPrec ListTagsForStreamResponse # readListPrec :: ReadPrec [ListTagsForStreamResponse] #
Show ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods showsPrec :: Int -> ListTagsForStreamResponse -> ShowS # show :: ListTagsForStreamResponse -> String # showList :: [ListTagsForStreamResponse] -> ShowS #
Generic ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Associated Types type Rep ListTagsForStreamResponse :: Type -> Type # Methods from :: ListTagsForStreamResponse -> Rep ListTagsForStreamResponse x # to :: Rep ListTagsForStreamResponse x -> ListTagsForStreamResponse #
NFData ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods rnf :: ListTagsForStreamResponse -> () #
type Rep ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream type Rep ListTagsForStreamResponse = D1 ('MetaData "ListTagsForStreamResponse" "Amazonka.Kinesis.ListTagsForStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListTagsForStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag]) :: S1 ('MetaSel ('Just "hasMoreTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newListTagsForStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTagsForStreamResponse'`
-> Bool	`$sel:hasMoreTags:ListTagsForStreamResponse'`
-> ListTagsForStreamResponse

Create a value of ListTagsForStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ListTagsForStreamResponse', listTagsForStreamResponse_httpStatus - The response's http status code.

$sel:tags:ListTagsForStreamResponse', listTagsForStreamResponse_tags - A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

$sel:hasMoreTags:ListTagsForStreamResponse', listTagsForStreamResponse_hasMoreTags - If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

DescribeStreamConsumer

data DescribeStreamConsumer Source #

See: newDescribeStreamConsumer smart constructor.

Constructors

DescribeStreamConsumer' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods (==) :: DescribeStreamConsumer -> DescribeStreamConsumer -> Bool # (/=) :: DescribeStreamConsumer -> DescribeStreamConsumer -> Bool #
Read DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods readsPrec :: Int -> ReadS DescribeStreamConsumer # readList :: ReadS [DescribeStreamConsumer] # readPrec :: ReadPrec DescribeStreamConsumer # readListPrec :: ReadPrec [DescribeStreamConsumer] #
Show DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods showsPrec :: Int -> DescribeStreamConsumer -> ShowS # show :: DescribeStreamConsumer -> String # showList :: [DescribeStreamConsumer] -> ShowS #
Generic DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Associated Types type Rep DescribeStreamConsumer :: Type -> Type # Methods from :: DescribeStreamConsumer -> Rep DescribeStreamConsumer x # to :: Rep DescribeStreamConsumer x -> DescribeStreamConsumer #
NFData DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods rnf :: DescribeStreamConsumer -> () #
Hashable DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods hashWithSalt :: Int -> DescribeStreamConsumer -> Int # hash :: DescribeStreamConsumer -> Int #
ToJSON DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods toJSON :: DescribeStreamConsumer -> Value # toEncoding :: DescribeStreamConsumer -> Encoding # toJSONList :: [DescribeStreamConsumer] -> Value # toEncodingList :: [DescribeStreamConsumer] -> Encoding #
AWSRequest DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Associated Types type AWSResponse DescribeStreamConsumer # Methods request :: DescribeStreamConsumer -> Request DescribeStreamConsumer # response :: MonadResource m => Logger -> Service -> Proxy DescribeStreamConsumer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStreamConsumer))) #
ToHeaders DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods toHeaders :: DescribeStreamConsumer -> [Header] #
ToPath DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods toPath :: DescribeStreamConsumer -> ByteString #
ToQuery DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods toQuery :: DescribeStreamConsumer -> QueryString #
type Rep DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer type Rep DescribeStreamConsumer = D1 ('MetaData "DescribeStreamConsumer" "Amazonka.Kinesis.DescribeStreamConsumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStreamConsumer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer type AWSResponse DescribeStreamConsumer = DescribeStreamConsumerResponse

newDescribeStreamConsumer :: DescribeStreamConsumer Source #

Create a value of DescribeStreamConsumer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:consumerARN:DescribeStreamConsumer', describeStreamConsumer_consumerARN - The ARN returned by Kinesis Data Streams when you registered the consumer.

$sel:streamARN:DescribeStreamConsumer', describeStreamConsumer_streamARN - The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

$sel:consumerName:DescribeStreamConsumer', describeStreamConsumer_consumerName - The name that you gave to the consumer.

data DescribeStreamConsumerResponse Source #

See: newDescribeStreamConsumerResponse smart constructor.

Constructors

DescribeStreamConsumerResponse' Int ConsumerDescription

Instances

Instances details

Eq DescribeStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods (==) :: DescribeStreamConsumerResponse -> DescribeStreamConsumerResponse -> Bool # (/=) :: DescribeStreamConsumerResponse -> DescribeStreamConsumerResponse -> Bool #
Read DescribeStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods readsPrec :: Int -> ReadS DescribeStreamConsumerResponse # readList :: ReadS [DescribeStreamConsumerResponse] # readPrec :: ReadPrec DescribeStreamConsumerResponse # readListPrec :: ReadPrec [DescribeStreamConsumerResponse] #
Show DescribeStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods showsPrec :: Int -> DescribeStreamConsumerResponse -> ShowS # show :: DescribeStreamConsumerResponse -> String # showList :: [DescribeStreamConsumerResponse] -> ShowS #
Generic DescribeStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Associated Types type Rep DescribeStreamConsumerResponse :: Type -> Type # Methods from :: DescribeStreamConsumerResponse -> Rep DescribeStreamConsumerResponse x # to :: Rep DescribeStreamConsumerResponse x -> DescribeStreamConsumerResponse #
NFData DescribeStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer Methods rnf :: DescribeStreamConsumerResponse -> () #
type Rep DescribeStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStreamConsumer type Rep DescribeStreamConsumerResponse = D1 ('MetaData "DescribeStreamConsumerResponse" "Amazonka.Kinesis.DescribeStreamConsumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStreamConsumerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "consumerDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConsumerDescription)))

newDescribeStreamConsumerResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeStreamConsumerResponse'`
-> ConsumerDescription	`$sel:consumerDescription:DescribeStreamConsumerResponse'`
-> DescribeStreamConsumerResponse

Create a value of DescribeStreamConsumerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeStreamConsumerResponse', describeStreamConsumerResponse_httpStatus - The response's http status code.

$sel:consumerDescription:DescribeStreamConsumerResponse', describeStreamConsumerResponse_consumerDescription - An object that represents the details of the consumer.

AddTagsToStream

data AddTagsToStream Source #

Represents the input for AddTagsToStream.

See: newAddTagsToStream smart constructor.

Constructors

AddTagsToStream' Text (HashMap Text Text)

Instances

Instances details

Eq AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods (==) :: AddTagsToStream -> AddTagsToStream -> Bool # (/=) :: AddTagsToStream -> AddTagsToStream -> Bool #
Read AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods readsPrec :: Int -> ReadS AddTagsToStream # readList :: ReadS [AddTagsToStream] # readPrec :: ReadPrec AddTagsToStream # readListPrec :: ReadPrec [AddTagsToStream] #
Show AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods showsPrec :: Int -> AddTagsToStream -> ShowS # show :: AddTagsToStream -> String # showList :: [AddTagsToStream] -> ShowS #
Generic AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Associated Types type Rep AddTagsToStream :: Type -> Type # Methods from :: AddTagsToStream -> Rep AddTagsToStream x # to :: Rep AddTagsToStream x -> AddTagsToStream #
NFData AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods rnf :: AddTagsToStream -> () #
Hashable AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods hashWithSalt :: Int -> AddTagsToStream -> Int # hash :: AddTagsToStream -> Int #
ToJSON AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods toJSON :: AddTagsToStream -> Value # toEncoding :: AddTagsToStream -> Encoding # toJSONList :: [AddTagsToStream] -> Value # toEncodingList :: [AddTagsToStream] -> Encoding #
AWSRequest AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Associated Types type AWSResponse AddTagsToStream # Methods request :: AddTagsToStream -> Request AddTagsToStream # response :: MonadResource m => Logger -> Service -> Proxy AddTagsToStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddTagsToStream))) #
ToHeaders AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods toHeaders :: AddTagsToStream -> [Header] #
ToPath AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods toPath :: AddTagsToStream -> ByteString #
ToQuery AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods toQuery :: AddTagsToStream -> QueryString #
type Rep AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream type Rep AddTagsToStream = D1 ('MetaData "AddTagsToStream" "Amazonka.Kinesis.AddTagsToStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "AddTagsToStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))
type AWSResponse AddTagsToStream Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream type AWSResponse AddTagsToStream = AddTagsToStreamResponse

newAddTagsToStream Source #

Arguments

:: Text	`$sel:streamName:AddTagsToStream'`
-> AddTagsToStream

Create a value of AddTagsToStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:AddTagsToStream', addTagsToStream_streamName - The name of the stream.

$sel:tags:AddTagsToStream', addTagsToStream_tags - A set of up to 10 key-value pairs to use to create the tags.

data AddTagsToStreamResponse Source #

See: newAddTagsToStreamResponse smart constructor.

Constructors

AddTagsToStreamResponse'

Instances

Instances details

Eq AddTagsToStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods (==) :: AddTagsToStreamResponse -> AddTagsToStreamResponse -> Bool # (/=) :: AddTagsToStreamResponse -> AddTagsToStreamResponse -> Bool #
Read AddTagsToStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods readsPrec :: Int -> ReadS AddTagsToStreamResponse # readList :: ReadS [AddTagsToStreamResponse] # readPrec :: ReadPrec AddTagsToStreamResponse # readListPrec :: ReadPrec [AddTagsToStreamResponse] #
Show AddTagsToStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods showsPrec :: Int -> AddTagsToStreamResponse -> ShowS # show :: AddTagsToStreamResponse -> String # showList :: [AddTagsToStreamResponse] -> ShowS #
Generic AddTagsToStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Associated Types type Rep AddTagsToStreamResponse :: Type -> Type # Methods from :: AddTagsToStreamResponse -> Rep AddTagsToStreamResponse x # to :: Rep AddTagsToStreamResponse x -> AddTagsToStreamResponse #
NFData AddTagsToStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream Methods rnf :: AddTagsToStreamResponse -> () #
type Rep AddTagsToStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.AddTagsToStream type Rep AddTagsToStreamResponse = D1 ('MetaData "AddTagsToStreamResponse" "Amazonka.Kinesis.AddTagsToStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "AddTagsToStreamResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAddTagsToStreamResponse :: AddTagsToStreamResponse Source #

Create a value of AddTagsToStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

PutRecords

data PutRecords Source #

A PutRecords request.

See: newPutRecords smart constructor.

Constructors

PutRecords' (NonEmpty PutRecordsRequestEntry) Text

Instances

Instances details

Eq PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods (==) :: PutRecords -> PutRecords -> Bool # (/=) :: PutRecords -> PutRecords -> Bool #
Read PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods readsPrec :: Int -> ReadS PutRecords # readList :: ReadS [PutRecords] # readPrec :: ReadPrec PutRecords # readListPrec :: ReadPrec [PutRecords] #
Show PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods showsPrec :: Int -> PutRecords -> ShowS # show :: PutRecords -> String # showList :: [PutRecords] -> ShowS #
Generic PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Associated Types type Rep PutRecords :: Type -> Type # Methods from :: PutRecords -> Rep PutRecords x # to :: Rep PutRecords x -> PutRecords #
NFData PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods rnf :: PutRecords -> () #
Hashable PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods hashWithSalt :: Int -> PutRecords -> Int # hash :: PutRecords -> Int #
ToJSON PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods toJSON :: PutRecords -> Value # toEncoding :: PutRecords -> Encoding # toJSONList :: [PutRecords] -> Value # toEncodingList :: [PutRecords] -> Encoding #
AWSRequest PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Associated Types type AWSResponse PutRecords # Methods request :: PutRecords -> Request PutRecords # response :: MonadResource m => Logger -> Service -> Proxy PutRecords -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutRecords))) #
ToHeaders PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods toHeaders :: PutRecords -> [Header] #
ToPath PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods toPath :: PutRecords -> ByteString #
ToQuery PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods toQuery :: PutRecords -> QueryString #
type Rep PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords type Rep PutRecords = D1 ('MetaData "PutRecords" "Amazonka.Kinesis.PutRecords" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "PutRecords'" 'PrefixI 'True) (S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty PutRecordsRequestEntry)) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse PutRecords Source #
Instance details Defined in Amazonka.Kinesis.PutRecords type AWSResponse PutRecords = PutRecordsResponse

newPutRecords Source #

Arguments

:: NonEmpty PutRecordsRequestEntry	`$sel:records:PutRecords'`
-> Text	`$sel:streamName:PutRecords'`
-> PutRecords

Create a value of PutRecords with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:records:PutRecords', putRecords_records - The records associated with the request.

$sel:streamName:PutRecords', putRecords_streamName - The stream name associated with the request.

data PutRecordsResponse Source #

PutRecords results.

See: newPutRecordsResponse smart constructor.

Constructors

PutRecordsResponse' (Maybe EncryptionType) (Maybe Natural) Int (NonEmpty PutRecordsResultEntry)

Instances

Instances details

Eq PutRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods (==) :: PutRecordsResponse -> PutRecordsResponse -> Bool # (/=) :: PutRecordsResponse -> PutRecordsResponse -> Bool #
Read PutRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods readsPrec :: Int -> ReadS PutRecordsResponse # readList :: ReadS [PutRecordsResponse] # readPrec :: ReadPrec PutRecordsResponse # readListPrec :: ReadPrec [PutRecordsResponse] #
Show PutRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods showsPrec :: Int -> PutRecordsResponse -> ShowS # show :: PutRecordsResponse -> String # showList :: [PutRecordsResponse] -> ShowS #
Generic PutRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Associated Types type Rep PutRecordsResponse :: Type -> Type # Methods from :: PutRecordsResponse -> Rep PutRecordsResponse x # to :: Rep PutRecordsResponse x -> PutRecordsResponse #
NFData PutRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecords Methods rnf :: PutRecordsResponse -> () #
type Rep PutRecordsResponse Source #
Instance details Defined in Amazonka.Kinesis.PutRecords type Rep PutRecordsResponse = D1 ('MetaData "PutRecordsResponse" "Amazonka.Kinesis.PutRecords" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "PutRecordsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionType)) :: S1 ('MetaSel ('Just "failedRecordCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty PutRecordsResultEntry)))))

newPutRecordsResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutRecordsResponse'`
-> NonEmpty PutRecordsResultEntry	`$sel:records:PutRecords'`
-> PutRecordsResponse

Create a value of PutRecordsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionType:PutRecordsResponse', putRecordsResponse_encryptionType - The encryption type used on the records. This parameter can be one of the following values:

NONE: Do not encrypt the records.
KMS: Use server-side encryption on the records using a customer-managed AWS KMS key.

$sel:failedRecordCount:PutRecordsResponse', putRecordsResponse_failedRecordCount - The number of unsuccessfully processed records in a PutRecords request.

$sel:httpStatus:PutRecordsResponse', putRecordsResponse_httpStatus - The response's http status code.

$sel:records:PutRecords', putRecordsResponse_records - 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 SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

ListShards (Paginated)

data ListShards Source #

See: newListShards smart constructor.

Constructors

ListShards' (Maybe ShardFilter) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural)

Instances

Instances details

Eq ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods (==) :: ListShards -> ListShards -> Bool # (/=) :: ListShards -> ListShards -> Bool #
Read ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods readsPrec :: Int -> ReadS ListShards # readList :: ReadS [ListShards] # readPrec :: ReadPrec ListShards # readListPrec :: ReadPrec [ListShards] #
Show ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods showsPrec :: Int -> ListShards -> ShowS # show :: ListShards -> String # showList :: [ListShards] -> ShowS #
Generic ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Associated Types type Rep ListShards :: Type -> Type # Methods from :: ListShards -> Rep ListShards x # to :: Rep ListShards x -> ListShards #
NFData ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods rnf :: ListShards -> () #
Hashable ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods hashWithSalt :: Int -> ListShards -> Int # hash :: ListShards -> Int #
ToJSON ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods toJSON :: ListShards -> Value # toEncoding :: ListShards -> Encoding # toJSONList :: [ListShards] -> Value # toEncodingList :: [ListShards] -> Encoding #
AWSPager ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods page :: ListShards -> AWSResponse ListShards -> Maybe ListShards #
AWSRequest ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Associated Types type AWSResponse ListShards # Methods request :: ListShards -> Request ListShards # response :: MonadResource m => Logger -> Service -> Proxy ListShards -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListShards))) #
ToHeaders ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods toHeaders :: ListShards -> [Header] #
ToPath ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods toPath :: ListShards -> ByteString #
ToQuery ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods toQuery :: ListShards -> QueryString #
type Rep ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards type Rep ListShards = D1 ('MetaData "ListShards" "Amazonka.Kinesis.ListShards" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListShards'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shardFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShardFilter)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "exclusiveStartShardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "streamCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListShards Source #
Instance details Defined in Amazonka.Kinesis.ListShards type AWSResponse ListShards = ListShardsResponse

newListShards :: ListShards Source #

Create a value of ListShards with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shardFilter:ListShards', listShards_shardFilter - Undocumented member.

$sel:nextToken:ListShards', listShards_nextToken - When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

$sel:exclusiveStartShardId:ListShards', listShards_exclusiveStartShardId - Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.

If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.

You cannot specify this parameter if you specify NextToken.

$sel:streamCreationTimestamp:ListShards', listShards_streamCreationTimestamp - Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.

You cannot specify this parameter if you specify the NextToken parameter.

$sel:streamName:ListShards', listShards_streamName - The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

$sel:maxResults:ListShards', listShards_maxResults - The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 10,000, which is also the default.

When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.

data ListShardsResponse Source #

See: newListShardsResponse smart constructor.

Constructors

ListShardsResponse' (Maybe Text) (Maybe [Shard]) Int

Instances

Instances details

Eq ListShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods (==) :: ListShardsResponse -> ListShardsResponse -> Bool # (/=) :: ListShardsResponse -> ListShardsResponse -> Bool #
Read ListShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods readsPrec :: Int -> ReadS ListShardsResponse # readList :: ReadS [ListShardsResponse] # readPrec :: ReadPrec ListShardsResponse # readListPrec :: ReadPrec [ListShardsResponse] #
Show ListShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods showsPrec :: Int -> ListShardsResponse -> ShowS # show :: ListShardsResponse -> String # showList :: [ListShardsResponse] -> ShowS #
Generic ListShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListShards Associated Types type Rep ListShardsResponse :: Type -> Type # Methods from :: ListShardsResponse -> Rep ListShardsResponse x # to :: Rep ListShardsResponse x -> ListShardsResponse #
NFData ListShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListShards Methods rnf :: ListShardsResponse -> () #
type Rep ListShardsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListShards type Rep ListShardsResponse = D1 ('MetaData "ListShardsResponse" "Amazonka.Kinesis.ListShards" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListShardsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Shard])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListShardsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListShardsResponse'`
-> ListShardsResponse

Create a value of ListShardsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListShards', listShardsResponse_nextToken - When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

$sel:shards:ListShardsResponse', listShardsResponse_shards - An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

$sel:httpStatus:ListShardsResponse', listShardsResponse_httpStatus - The response's http status code.

DeleteStream

data DeleteStream Source #

Represents the input for DeleteStream.

See: newDeleteStream smart constructor.

Constructors

DeleteStream' (Maybe Bool) Text

Instances

Instances details

Eq DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods (==) :: DeleteStream -> DeleteStream -> Bool # (/=) :: DeleteStream -> DeleteStream -> Bool #
Read DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods readsPrec :: Int -> ReadS DeleteStream # readList :: ReadS [DeleteStream] # readPrec :: ReadPrec DeleteStream # readListPrec :: ReadPrec [DeleteStream] #
Show DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods showsPrec :: Int -> DeleteStream -> ShowS # show :: DeleteStream -> String # showList :: [DeleteStream] -> ShowS #
Generic DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Associated Types type Rep DeleteStream :: Type -> Type # Methods from :: DeleteStream -> Rep DeleteStream x # to :: Rep DeleteStream x -> DeleteStream #
NFData DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods rnf :: DeleteStream -> () #
Hashable DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods hashWithSalt :: Int -> DeleteStream -> Int # hash :: DeleteStream -> Int #
ToJSON DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods toJSON :: DeleteStream -> Value # toEncoding :: DeleteStream -> Encoding # toJSONList :: [DeleteStream] -> Value # toEncodingList :: [DeleteStream] -> Encoding #
AWSRequest DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Associated Types type AWSResponse DeleteStream # Methods request :: DeleteStream -> Request DeleteStream # response :: MonadResource m => Logger -> Service -> Proxy DeleteStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteStream))) #
ToHeaders DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods toHeaders :: DeleteStream -> [Header] #
ToPath DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods toPath :: DeleteStream -> ByteString #
ToQuery DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods toQuery :: DeleteStream -> QueryString #
type Rep DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream type Rep DeleteStream = D1 ('MetaData "DeleteStream" "Amazonka.Kinesis.DeleteStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DeleteStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enforceConsumerDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream type AWSResponse DeleteStream = DeleteStreamResponse

newDeleteStream Source #

Arguments

:: Text	`$sel:streamName:DeleteStream'`
-> DeleteStream

Create a value of DeleteStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:enforceConsumerDeletion:DeleteStream', deleteStream_enforceConsumerDeletion - If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

$sel:streamName:DeleteStream', deleteStream_streamName - The name of the stream to delete.

data DeleteStreamResponse Source #

See: newDeleteStreamResponse smart constructor.

Constructors

DeleteStreamResponse'

Instances

Instances details

Eq DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods (==) :: DeleteStreamResponse -> DeleteStreamResponse -> Bool # (/=) :: DeleteStreamResponse -> DeleteStreamResponse -> Bool #
Read DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods readsPrec :: Int -> ReadS DeleteStreamResponse # readList :: ReadS [DeleteStreamResponse] # readPrec :: ReadPrec DeleteStreamResponse # readListPrec :: ReadPrec [DeleteStreamResponse] #
Show DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods showsPrec :: Int -> DeleteStreamResponse -> ShowS # show :: DeleteStreamResponse -> String # showList :: [DeleteStreamResponse] -> ShowS #
Generic DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Associated Types type Rep DeleteStreamResponse :: Type -> Type # Methods from :: DeleteStreamResponse -> Rep DeleteStreamResponse x # to :: Rep DeleteStreamResponse x -> DeleteStreamResponse #
NFData DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods rnf :: DeleteStreamResponse -> () #
type Rep DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream type Rep DeleteStreamResponse = D1 ('MetaData "DeleteStreamResponse" "Amazonka.Kinesis.DeleteStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DeleteStreamResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteStreamResponse :: DeleteStreamResponse Source #

Create a value of DeleteStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

RemoveTagsFromStream

data RemoveTagsFromStream Source #

Represents the input for RemoveTagsFromStream.

See: newRemoveTagsFromStream smart constructor.

Constructors

RemoveTagsFromStream' Text (NonEmpty Text)

Instances

Instances details

Eq RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods (==) :: RemoveTagsFromStream -> RemoveTagsFromStream -> Bool # (/=) :: RemoveTagsFromStream -> RemoveTagsFromStream -> Bool #
Read RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods readsPrec :: Int -> ReadS RemoveTagsFromStream # readList :: ReadS [RemoveTagsFromStream] # readPrec :: ReadPrec RemoveTagsFromStream # readListPrec :: ReadPrec [RemoveTagsFromStream] #
Show RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods showsPrec :: Int -> RemoveTagsFromStream -> ShowS # show :: RemoveTagsFromStream -> String # showList :: [RemoveTagsFromStream] -> ShowS #
Generic RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Associated Types type Rep RemoveTagsFromStream :: Type -> Type # Methods from :: RemoveTagsFromStream -> Rep RemoveTagsFromStream x # to :: Rep RemoveTagsFromStream x -> RemoveTagsFromStream #
NFData RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods rnf :: RemoveTagsFromStream -> () #
Hashable RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods hashWithSalt :: Int -> RemoveTagsFromStream -> Int # hash :: RemoveTagsFromStream -> Int #
ToJSON RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods toJSON :: RemoveTagsFromStream -> Value # toEncoding :: RemoveTagsFromStream -> Encoding # toJSONList :: [RemoveTagsFromStream] -> Value # toEncodingList :: [RemoveTagsFromStream] -> Encoding #
AWSRequest RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Associated Types type AWSResponse RemoveTagsFromStream # Methods request :: RemoveTagsFromStream -> Request RemoveTagsFromStream # response :: MonadResource m => Logger -> Service -> Proxy RemoveTagsFromStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RemoveTagsFromStream))) #
ToHeaders RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods toHeaders :: RemoveTagsFromStream -> [Header] #
ToPath RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods toPath :: RemoveTagsFromStream -> ByteString #
ToQuery RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods toQuery :: RemoveTagsFromStream -> QueryString #
type Rep RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream type Rep RemoveTagsFromStream = D1 ('MetaData "RemoveTagsFromStream" "Amazonka.Kinesis.RemoveTagsFromStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "RemoveTagsFromStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))
type AWSResponse RemoveTagsFromStream Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream type AWSResponse RemoveTagsFromStream = RemoveTagsFromStreamResponse

newRemoveTagsFromStream Source #

Arguments

:: Text	`$sel:streamName:RemoveTagsFromStream'`
-> NonEmpty Text	`$sel:tagKeys:RemoveTagsFromStream'`
-> RemoveTagsFromStream

Create a value of RemoveTagsFromStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:RemoveTagsFromStream', removeTagsFromStream_streamName - The name of the stream.

$sel:tagKeys:RemoveTagsFromStream', removeTagsFromStream_tagKeys - A list of tag keys. Each corresponding tag is removed from the stream.

data RemoveTagsFromStreamResponse Source #

See: newRemoveTagsFromStreamResponse smart constructor.

Constructors

RemoveTagsFromStreamResponse'

Instances

Instances details

Eq RemoveTagsFromStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods (==) :: RemoveTagsFromStreamResponse -> RemoveTagsFromStreamResponse -> Bool # (/=) :: RemoveTagsFromStreamResponse -> RemoveTagsFromStreamResponse -> Bool #
Read RemoveTagsFromStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods readsPrec :: Int -> ReadS RemoveTagsFromStreamResponse # readList :: ReadS [RemoveTagsFromStreamResponse] # readPrec :: ReadPrec RemoveTagsFromStreamResponse # readListPrec :: ReadPrec [RemoveTagsFromStreamResponse] #
Show RemoveTagsFromStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods showsPrec :: Int -> RemoveTagsFromStreamResponse -> ShowS # show :: RemoveTagsFromStreamResponse -> String # showList :: [RemoveTagsFromStreamResponse] -> ShowS #
Generic RemoveTagsFromStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Associated Types type Rep RemoveTagsFromStreamResponse :: Type -> Type # Methods from :: RemoveTagsFromStreamResponse -> Rep RemoveTagsFromStreamResponse x # to :: Rep RemoveTagsFromStreamResponse x -> RemoveTagsFromStreamResponse #
NFData RemoveTagsFromStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream Methods rnf :: RemoveTagsFromStreamResponse -> () #
type Rep RemoveTagsFromStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.RemoveTagsFromStream type Rep RemoveTagsFromStreamResponse = D1 ('MetaData "RemoveTagsFromStreamResponse" "Amazonka.Kinesis.RemoveTagsFromStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "RemoveTagsFromStreamResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRemoveTagsFromStreamResponse :: RemoveTagsFromStreamResponse Source #

Create a value of RemoveTagsFromStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

ListStreams (Paginated)

data ListStreams Source #

Represents the input for ListStreams.

See: newListStreams smart constructor.

Constructors

ListStreams' (Maybe Natural) (Maybe Text)

Instances

Instances details

Eq ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods (==) :: ListStreams -> ListStreams -> Bool # (/=) :: ListStreams -> ListStreams -> Bool #
Read ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods readsPrec :: Int -> ReadS ListStreams # readList :: ReadS [ListStreams] # readPrec :: ReadPrec ListStreams # readListPrec :: ReadPrec [ListStreams] #
Show ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods showsPrec :: Int -> ListStreams -> ShowS # show :: ListStreams -> String # showList :: [ListStreams] -> ShowS #
Generic ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Associated Types type Rep ListStreams :: Type -> Type # Methods from :: ListStreams -> Rep ListStreams x # to :: Rep ListStreams x -> ListStreams #
NFData ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods rnf :: ListStreams -> () #
Hashable ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods hashWithSalt :: Int -> ListStreams -> Int # hash :: ListStreams -> Int #
ToJSON ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toJSON :: ListStreams -> Value # toEncoding :: ListStreams -> Encoding # toJSONList :: [ListStreams] -> Value # toEncodingList :: [ListStreams] -> Encoding #
AWSPager ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods page :: ListStreams -> AWSResponse ListStreams -> Maybe ListStreams #
AWSRequest ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Associated Types type AWSResponse ListStreams # Methods request :: ListStreams -> Request ListStreams # response :: MonadResource m => Logger -> Service -> Proxy ListStreams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStreams))) #
ToHeaders ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toHeaders :: ListStreams -> [Header] #
ToPath ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toPath :: ListStreams -> ByteString #
ToQuery ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toQuery :: ListStreams -> QueryString #
type Rep ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams type Rep ListStreams = D1 ('MetaData "ListStreams" "Amazonka.Kinesis.ListStreams" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "exclusiveStartStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams type AWSResponse ListStreams = ListStreamsResponse

newListStreams :: ListStreams Source #

Create a value of ListStreams with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListStreams', listStreams_limit - The maximum number of streams to list.

$sel:exclusiveStartStreamName:ListStreams', listStreams_exclusiveStartStreamName - The name of the stream to start the list with.

data ListStreamsResponse Source #

Represents the output for ListStreams.

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse' Int [Text] Bool

Instances

Instances details

Eq ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods (==) :: ListStreamsResponse -> ListStreamsResponse -> Bool # (/=) :: ListStreamsResponse -> ListStreamsResponse -> Bool #
Read ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods readsPrec :: Int -> ReadS ListStreamsResponse # readList :: ReadS [ListStreamsResponse] # readPrec :: ReadPrec ListStreamsResponse # readListPrec :: ReadPrec [ListStreamsResponse] #
Show ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods showsPrec :: Int -> ListStreamsResponse -> ShowS # show :: ListStreamsResponse -> String # showList :: [ListStreamsResponse] -> ShowS #
Generic ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Associated Types type Rep ListStreamsResponse :: Type -> Type # Methods from :: ListStreamsResponse -> Rep ListStreamsResponse x # to :: Rep ListStreamsResponse x -> ListStreamsResponse #
NFData ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods rnf :: ListStreamsResponse -> () #
type Rep ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams type Rep ListStreamsResponse = D1 ('MetaData "ListStreamsResponse" "Amazonka.Kinesis.ListStreams" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "streamNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "hasMoreStreams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newListStreamsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListStreamsResponse'`
-> Bool	`$sel:hasMoreStreams:ListStreamsResponse'`
-> ListStreamsResponse

Create a value of ListStreamsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.

$sel:streamNames:ListStreamsResponse', listStreamsResponse_streamNames - The names of the streams that are associated with the AWS account making the ListStreams request.

$sel:hasMoreStreams:ListStreamsResponse', listStreamsResponse_hasMoreStreams - If set to true, there are more streams available to list.

CreateStream

data CreateStream Source #

Represents the input for CreateStream.

See: newCreateStream smart constructor.

Constructors

CreateStream' Text Natural

Instances

Instances details

Eq CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods (==) :: CreateStream -> CreateStream -> Bool # (/=) :: CreateStream -> CreateStream -> Bool #
Read CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods readsPrec :: Int -> ReadS CreateStream # readList :: ReadS [CreateStream] # readPrec :: ReadPrec CreateStream # readListPrec :: ReadPrec [CreateStream] #
Show CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods showsPrec :: Int -> CreateStream -> ShowS # show :: CreateStream -> String # showList :: [CreateStream] -> ShowS #
Generic CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Associated Types type Rep CreateStream :: Type -> Type # Methods from :: CreateStream -> Rep CreateStream x # to :: Rep CreateStream x -> CreateStream #
NFData CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods rnf :: CreateStream -> () #
Hashable CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods hashWithSalt :: Int -> CreateStream -> Int # hash :: CreateStream -> Int #
ToJSON CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods toJSON :: CreateStream -> Value # toEncoding :: CreateStream -> Encoding # toJSONList :: [CreateStream] -> Value # toEncodingList :: [CreateStream] -> Encoding #
AWSRequest CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Associated Types type AWSResponse CreateStream # Methods request :: CreateStream -> Request CreateStream # response :: MonadResource m => Logger -> Service -> Proxy CreateStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStream))) #
ToHeaders CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods toHeaders :: CreateStream -> [Header] #
ToPath CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods toPath :: CreateStream -> ByteString #
ToQuery CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods toQuery :: CreateStream -> QueryString #
type Rep CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream type Rep CreateStream = D1 ('MetaData "CreateStream" "Amazonka.Kinesis.CreateStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "CreateStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))
type AWSResponse CreateStream Source #
Instance details Defined in Amazonka.Kinesis.CreateStream type AWSResponse CreateStream = CreateStreamResponse

newCreateStream Source #

Arguments

:: Text	`$sel:streamName:CreateStream'`
-> Natural	`$sel:shardCount:CreateStream'`
-> CreateStream

Create a value of CreateStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:CreateStream', createStream_streamName - 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.

$sel:shardCount:CreateStream', createStream_shardCount - The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

data CreateStreamResponse Source #

See: newCreateStreamResponse smart constructor.

Constructors

CreateStreamResponse'

Instances

Instances details

Eq CreateStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods (==) :: CreateStreamResponse -> CreateStreamResponse -> Bool # (/=) :: CreateStreamResponse -> CreateStreamResponse -> Bool #
Read CreateStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods readsPrec :: Int -> ReadS CreateStreamResponse # readList :: ReadS [CreateStreamResponse] # readPrec :: ReadPrec CreateStreamResponse # readListPrec :: ReadPrec [CreateStreamResponse] #
Show CreateStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods showsPrec :: Int -> CreateStreamResponse -> ShowS # show :: CreateStreamResponse -> String # showList :: [CreateStreamResponse] -> ShowS #
Generic CreateStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Associated Types type Rep CreateStreamResponse :: Type -> Type # Methods from :: CreateStreamResponse -> Rep CreateStreamResponse x # to :: Rep CreateStreamResponse x -> CreateStreamResponse #
NFData CreateStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.CreateStream Methods rnf :: CreateStreamResponse -> () #
type Rep CreateStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.CreateStream type Rep CreateStreamResponse = D1 ('MetaData "CreateStreamResponse" "Amazonka.Kinesis.CreateStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "CreateStreamResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCreateStreamResponse :: CreateStreamResponse Source #

Create a value of CreateStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

StartStreamEncryption

data StartStreamEncryption Source #

See: newStartStreamEncryption smart constructor.

Constructors

StartStreamEncryption' Text EncryptionType Text

Instances

Instances details

Eq StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods (==) :: StartStreamEncryption -> StartStreamEncryption -> Bool # (/=) :: StartStreamEncryption -> StartStreamEncryption -> Bool #
Read StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods readsPrec :: Int -> ReadS StartStreamEncryption # readList :: ReadS [StartStreamEncryption] # readPrec :: ReadPrec StartStreamEncryption # readListPrec :: ReadPrec [StartStreamEncryption] #
Show StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods showsPrec :: Int -> StartStreamEncryption -> ShowS # show :: StartStreamEncryption -> String # showList :: [StartStreamEncryption] -> ShowS #
Generic StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Associated Types type Rep StartStreamEncryption :: Type -> Type # Methods from :: StartStreamEncryption -> Rep StartStreamEncryption x # to :: Rep StartStreamEncryption x -> StartStreamEncryption #
NFData StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods rnf :: StartStreamEncryption -> () #
Hashable StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods hashWithSalt :: Int -> StartStreamEncryption -> Int # hash :: StartStreamEncryption -> Int #
ToJSON StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toJSON :: StartStreamEncryption -> Value # toEncoding :: StartStreamEncryption -> Encoding # toJSONList :: [StartStreamEncryption] -> Value # toEncodingList :: [StartStreamEncryption] -> Encoding #
AWSRequest StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Associated Types type AWSResponse StartStreamEncryption # Methods request :: StartStreamEncryption -> Request StartStreamEncryption # response :: MonadResource m => Logger -> Service -> Proxy StartStreamEncryption -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartStreamEncryption))) #
ToHeaders StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toHeaders :: StartStreamEncryption -> [Header] #
ToPath StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toPath :: StartStreamEncryption -> ByteString #
ToQuery StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toQuery :: StartStreamEncryption -> QueryString #
type Rep StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption type Rep StartStreamEncryption = D1 ('MetaData "StartStreamEncryption" "Amazonka.Kinesis.StartStreamEncryption" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StartStreamEncryption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionType) :: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption type AWSResponse StartStreamEncryption = StartStreamEncryptionResponse

newStartStreamEncryption Source #

Arguments

:: Text	`$sel:streamName:StartStreamEncryption'`
-> EncryptionType	`$sel:encryptionType:StartStreamEncryption'`
-> Text	`$sel:keyId:StartStreamEncryption'`
-> StartStreamEncryption

Create a value of StartStreamEncryption with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:StartStreamEncryption', startStreamEncryption_streamName - The name of the stream for which to start encrypting records.

$sel:encryptionType:StartStreamEncryption', startStreamEncryption_encryptionType - The encryption type to use. The only valid value is KMS.

$sel:keyId:StartStreamEncryption', startStreamEncryption_keyId - 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/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis

data StartStreamEncryptionResponse Source #

See: newStartStreamEncryptionResponse smart constructor.

Constructors

StartStreamEncryptionResponse'

Instances

Instances details

Eq StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods (==) :: StartStreamEncryptionResponse -> StartStreamEncryptionResponse -> Bool # (/=) :: StartStreamEncryptionResponse -> StartStreamEncryptionResponse -> Bool #
Read StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods readsPrec :: Int -> ReadS StartStreamEncryptionResponse # readList :: ReadS [StartStreamEncryptionResponse] # readPrec :: ReadPrec StartStreamEncryptionResponse # readListPrec :: ReadPrec [StartStreamEncryptionResponse] #
Show StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods showsPrec :: Int -> StartStreamEncryptionResponse -> ShowS # show :: StartStreamEncryptionResponse -> String # showList :: [StartStreamEncryptionResponse] -> ShowS #
Generic StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Associated Types type Rep StartStreamEncryptionResponse :: Type -> Type # Methods from :: StartStreamEncryptionResponse -> Rep StartStreamEncryptionResponse x # to :: Rep StartStreamEncryptionResponse x -> StartStreamEncryptionResponse #
NFData StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods rnf :: StartStreamEncryptionResponse -> () #
type Rep StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption type Rep StartStreamEncryptionResponse = D1 ('MetaData "StartStreamEncryptionResponse" "Amazonka.Kinesis.StartStreamEncryption" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StartStreamEncryptionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStartStreamEncryptionResponse :: StartStreamEncryptionResponse Source #

Create a value of StartStreamEncryptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

ListStreamConsumers (Paginated)

data ListStreamConsumers Source #

See: newListStreamConsumers smart constructor.

Constructors

ListStreamConsumers' (Maybe Text) (Maybe POSIX) (Maybe Natural) Text

Instances

Instances details

Eq ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods (==) :: ListStreamConsumers -> ListStreamConsumers -> Bool # (/=) :: ListStreamConsumers -> ListStreamConsumers -> Bool #
Read ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods readsPrec :: Int -> ReadS ListStreamConsumers # readList :: ReadS [ListStreamConsumers] # readPrec :: ReadPrec ListStreamConsumers # readListPrec :: ReadPrec [ListStreamConsumers] #
Show ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods showsPrec :: Int -> ListStreamConsumers -> ShowS # show :: ListStreamConsumers -> String # showList :: [ListStreamConsumers] -> ShowS #
Generic ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Associated Types type Rep ListStreamConsumers :: Type -> Type # Methods from :: ListStreamConsumers -> Rep ListStreamConsumers x # to :: Rep ListStreamConsumers x -> ListStreamConsumers #
NFData ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods rnf :: ListStreamConsumers -> () #
Hashable ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods hashWithSalt :: Int -> ListStreamConsumers -> Int # hash :: ListStreamConsumers -> Int #
ToJSON ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods toJSON :: ListStreamConsumers -> Value # toEncoding :: ListStreamConsumers -> Encoding # toJSONList :: [ListStreamConsumers] -> Value # toEncodingList :: [ListStreamConsumers] -> Encoding #
AWSPager ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods page :: ListStreamConsumers -> AWSResponse ListStreamConsumers -> Maybe ListStreamConsumers #
AWSRequest ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Associated Types type AWSResponse ListStreamConsumers # Methods request :: ListStreamConsumers -> Request ListStreamConsumers # response :: MonadResource m => Logger -> Service -> Proxy ListStreamConsumers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStreamConsumers))) #
ToHeaders ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods toHeaders :: ListStreamConsumers -> [Header] #
ToPath ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods toPath :: ListStreamConsumers -> ByteString #
ToQuery ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods toQuery :: ListStreamConsumers -> QueryString #
type Rep ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers type Rep ListStreamConsumers = D1 ('MetaData "ListStreamConsumers" "Amazonka.Kinesis.ListStreamConsumers" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListStreamConsumers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListStreamConsumers Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers type AWSResponse ListStreamConsumers = ListStreamConsumersResponse

newListStreamConsumers Source #

Arguments

:: Text	`$sel:streamARN:ListStreamConsumers'`
-> ListStreamConsumers

Create a value of ListStreamConsumers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListStreamConsumers', listStreamConsumers_nextToken - When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of consumers that are registered with the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

$sel:streamCreationTimestamp:ListStreamConsumers', listStreamConsumers_streamCreationTimestamp - Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

$sel:maxResults:ListStreamConsumers', listStreamConsumers_maxResults - The maximum number of consumers that you want a single call of ListStreamConsumers to return.

$sel:streamARN:ListStreamConsumers', listStreamConsumers_streamARN - The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

data ListStreamConsumersResponse Source #

See: newListStreamConsumersResponse smart constructor.

Constructors

ListStreamConsumersResponse' (Maybe Text) (Maybe [Consumer]) Int

Instances

Instances details

Eq ListStreamConsumersResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods (==) :: ListStreamConsumersResponse -> ListStreamConsumersResponse -> Bool # (/=) :: ListStreamConsumersResponse -> ListStreamConsumersResponse -> Bool #
Read ListStreamConsumersResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods readsPrec :: Int -> ReadS ListStreamConsumersResponse # readList :: ReadS [ListStreamConsumersResponse] # readPrec :: ReadPrec ListStreamConsumersResponse # readListPrec :: ReadPrec [ListStreamConsumersResponse] #
Show ListStreamConsumersResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods showsPrec :: Int -> ListStreamConsumersResponse -> ShowS # show :: ListStreamConsumersResponse -> String # showList :: [ListStreamConsumersResponse] -> ShowS #
Generic ListStreamConsumersResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Associated Types type Rep ListStreamConsumersResponse :: Type -> Type # Methods from :: ListStreamConsumersResponse -> Rep ListStreamConsumersResponse x # to :: Rep ListStreamConsumersResponse x -> ListStreamConsumersResponse #
NFData ListStreamConsumersResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers Methods rnf :: ListStreamConsumersResponse -> () #
type Rep ListStreamConsumersResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreamConsumers type Rep ListStreamConsumersResponse = D1 ('MetaData "ListStreamConsumersResponse" "Amazonka.Kinesis.ListStreamConsumers" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListStreamConsumersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "consumers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Consumer])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStreamConsumersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListStreamConsumersResponse'`
-> ListStreamConsumersResponse

Create a value of ListStreamConsumersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListStreamConsumers', listStreamConsumersResponse_nextToken - When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

$sel:consumers:ListStreamConsumersResponse', listStreamConsumersResponse_consumers - An array of JSON objects. Each object represents one registered consumer.

$sel:httpStatus:ListStreamConsumersResponse', listStreamConsumersResponse_httpStatus - The response's http status code.

SplitShard

data SplitShard Source #

Represents the input for SplitShard.

See: newSplitShard smart constructor.

Constructors

SplitShard' Text Text Text

Instances

Instances details

Eq SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods (==) :: SplitShard -> SplitShard -> Bool # (/=) :: SplitShard -> SplitShard -> Bool #
Read SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods readsPrec :: Int -> ReadS SplitShard # readList :: ReadS [SplitShard] # readPrec :: ReadPrec SplitShard # readListPrec :: ReadPrec [SplitShard] #
Show SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods showsPrec :: Int -> SplitShard -> ShowS # show :: SplitShard -> String # showList :: [SplitShard] -> ShowS #
Generic SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Associated Types type Rep SplitShard :: Type -> Type # Methods from :: SplitShard -> Rep SplitShard x # to :: Rep SplitShard x -> SplitShard #
NFData SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods rnf :: SplitShard -> () #
Hashable SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods hashWithSalt :: Int -> SplitShard -> Int # hash :: SplitShard -> Int #
ToJSON SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods toJSON :: SplitShard -> Value # toEncoding :: SplitShard -> Encoding # toJSONList :: [SplitShard] -> Value # toEncodingList :: [SplitShard] -> Encoding #
AWSRequest SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Associated Types type AWSResponse SplitShard # Methods request :: SplitShard -> Request SplitShard # response :: MonadResource m => Logger -> Service -> Proxy SplitShard -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SplitShard))) #
ToHeaders SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods toHeaders :: SplitShard -> [Header] #
ToPath SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods toPath :: SplitShard -> ByteString #
ToQuery SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods toQuery :: SplitShard -> QueryString #
type Rep SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard type Rep SplitShard = D1 ('MetaData "SplitShard" "Amazonka.Kinesis.SplitShard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SplitShard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "shardToSplit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "newStartingHashKey'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SplitShard Source #
Instance details Defined in Amazonka.Kinesis.SplitShard type AWSResponse SplitShard = SplitShardResponse

newSplitShard Source #

Arguments

:: Text	`$sel:streamName:SplitShard'`
-> Text	`$sel:shardToSplit:SplitShard'`
-> Text	`$sel:newStartingHashKey':SplitShard'`
-> SplitShard

Create a value of SplitShard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:SplitShard', splitShard_streamName - The name of the stream for the shard split.

$sel:shardToSplit:SplitShard', splitShard_shardToSplit - The shard ID of the shard to split.

$sel:newStartingHashKey':SplitShard', splitShard_newStartingHashKey - A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

data SplitShardResponse Source #

See: newSplitShardResponse smart constructor.

Constructors

SplitShardResponse'

Instances

Instances details

Eq SplitShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods (==) :: SplitShardResponse -> SplitShardResponse -> Bool # (/=) :: SplitShardResponse -> SplitShardResponse -> Bool #
Read SplitShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods readsPrec :: Int -> ReadS SplitShardResponse # readList :: ReadS [SplitShardResponse] # readPrec :: ReadPrec SplitShardResponse # readListPrec :: ReadPrec [SplitShardResponse] #
Show SplitShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods showsPrec :: Int -> SplitShardResponse -> ShowS # show :: SplitShardResponse -> String # showList :: [SplitShardResponse] -> ShowS #
Generic SplitShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Associated Types type Rep SplitShardResponse :: Type -> Type # Methods from :: SplitShardResponse -> Rep SplitShardResponse x # to :: Rep SplitShardResponse x -> SplitShardResponse #
NFData SplitShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SplitShard Methods rnf :: SplitShardResponse -> () #
type Rep SplitShardResponse Source #
Instance details Defined in Amazonka.Kinesis.SplitShard type Rep SplitShardResponse = D1 ('MetaData "SplitShardResponse" "Amazonka.Kinesis.SplitShard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SplitShardResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSplitShardResponse :: SplitShardResponse Source #

Create a value of SplitShardResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

IncreaseStreamRetentionPeriod

data IncreaseStreamRetentionPeriod Source #

Represents the input for IncreaseStreamRetentionPeriod.

See: newIncreaseStreamRetentionPeriod smart constructor.

Constructors

IncreaseStreamRetentionPeriod' Text Int

Instances

Instances details

Eq IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods (==) :: IncreaseStreamRetentionPeriod -> IncreaseStreamRetentionPeriod -> Bool # (/=) :: IncreaseStreamRetentionPeriod -> IncreaseStreamRetentionPeriod -> Bool #
Read IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods readsPrec :: Int -> ReadS IncreaseStreamRetentionPeriod # readList :: ReadS [IncreaseStreamRetentionPeriod] # readPrec :: ReadPrec IncreaseStreamRetentionPeriod # readListPrec :: ReadPrec [IncreaseStreamRetentionPeriod] #
Show IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods showsPrec :: Int -> IncreaseStreamRetentionPeriod -> ShowS # show :: IncreaseStreamRetentionPeriod -> String # showList :: [IncreaseStreamRetentionPeriod] -> ShowS #
Generic IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Associated Types type Rep IncreaseStreamRetentionPeriod :: Type -> Type # Methods from :: IncreaseStreamRetentionPeriod -> Rep IncreaseStreamRetentionPeriod x # to :: Rep IncreaseStreamRetentionPeriod x -> IncreaseStreamRetentionPeriod #
NFData IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods rnf :: IncreaseStreamRetentionPeriod -> () #
Hashable IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods hashWithSalt :: Int -> IncreaseStreamRetentionPeriod -> Int # hash :: IncreaseStreamRetentionPeriod -> Int #
ToJSON IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods toJSON :: IncreaseStreamRetentionPeriod -> Value # toEncoding :: IncreaseStreamRetentionPeriod -> Encoding # toJSONList :: [IncreaseStreamRetentionPeriod] -> Value # toEncodingList :: [IncreaseStreamRetentionPeriod] -> Encoding #
AWSRequest IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Associated Types type AWSResponse IncreaseStreamRetentionPeriod # Methods request :: IncreaseStreamRetentionPeriod -> Request IncreaseStreamRetentionPeriod # response :: MonadResource m => Logger -> Service -> Proxy IncreaseStreamRetentionPeriod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse IncreaseStreamRetentionPeriod))) #
ToHeaders IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods toHeaders :: IncreaseStreamRetentionPeriod -> [Header] #
ToPath IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods toPath :: IncreaseStreamRetentionPeriod -> ByteString #
ToQuery IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods toQuery :: IncreaseStreamRetentionPeriod -> QueryString #
type Rep IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod type Rep IncreaseStreamRetentionPeriod = D1 ('MetaData "IncreaseStreamRetentionPeriod" "Amazonka.Kinesis.IncreaseStreamRetentionPeriod" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "IncreaseStreamRetentionPeriod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "retentionPeriodHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))
type AWSResponse IncreaseStreamRetentionPeriod Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod type AWSResponse IncreaseStreamRetentionPeriod = IncreaseStreamRetentionPeriodResponse

newIncreaseStreamRetentionPeriod Source #

Arguments

:: Text	`$sel:streamName:IncreaseStreamRetentionPeriod'`
-> Int	`$sel:retentionPeriodHours:IncreaseStreamRetentionPeriod'`
-> IncreaseStreamRetentionPeriod

Create a value of IncreaseStreamRetentionPeriod with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:IncreaseStreamRetentionPeriod', increaseStreamRetentionPeriod_streamName - The name of the stream to modify.

$sel:retentionPeriodHours:IncreaseStreamRetentionPeriod', increaseStreamRetentionPeriod_retentionPeriodHours - The new retention period of the stream, in hours. Must be more than the current retention period.

data IncreaseStreamRetentionPeriodResponse Source #

See: newIncreaseStreamRetentionPeriodResponse smart constructor.

Constructors

IncreaseStreamRetentionPeriodResponse'

Instances

Instances details

Eq IncreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods (==) :: IncreaseStreamRetentionPeriodResponse -> IncreaseStreamRetentionPeriodResponse -> Bool # (/=) :: IncreaseStreamRetentionPeriodResponse -> IncreaseStreamRetentionPeriodResponse -> Bool #
Read IncreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods readsPrec :: Int -> ReadS IncreaseStreamRetentionPeriodResponse # readList :: ReadS [IncreaseStreamRetentionPeriodResponse] # readPrec :: ReadPrec IncreaseStreamRetentionPeriodResponse # readListPrec :: ReadPrec [IncreaseStreamRetentionPeriodResponse] #
Show IncreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods showsPrec :: Int -> IncreaseStreamRetentionPeriodResponse -> ShowS # show :: IncreaseStreamRetentionPeriodResponse -> String # showList :: [IncreaseStreamRetentionPeriodResponse] -> ShowS #
Generic IncreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Associated Types type Rep IncreaseStreamRetentionPeriodResponse :: Type -> Type # Methods from :: IncreaseStreamRetentionPeriodResponse -> Rep IncreaseStreamRetentionPeriodResponse x # to :: Rep IncreaseStreamRetentionPeriodResponse x -> IncreaseStreamRetentionPeriodResponse #
NFData IncreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod Methods rnf :: IncreaseStreamRetentionPeriodResponse -> () #
type Rep IncreaseStreamRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Kinesis.IncreaseStreamRetentionPeriod type Rep IncreaseStreamRetentionPeriodResponse = D1 ('MetaData "IncreaseStreamRetentionPeriodResponse" "Amazonka.Kinesis.IncreaseStreamRetentionPeriod" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "IncreaseStreamRetentionPeriodResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newIncreaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse Source #

Create a value of IncreaseStreamRetentionPeriodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DescribeStream (Paginated)

data DescribeStream Source #

Represents the input for DescribeStream.

See: newDescribeStream smart constructor.

Constructors

DescribeStream' (Maybe Text) (Maybe Natural) Text

Instances

Instances details

Eq DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods (==) :: DescribeStream -> DescribeStream -> Bool # (/=) :: DescribeStream -> DescribeStream -> Bool #
Read DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods readsPrec :: Int -> ReadS DescribeStream # readList :: ReadS [DescribeStream] # readPrec :: ReadPrec DescribeStream # readListPrec :: ReadPrec [DescribeStream] #
Show DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods showsPrec :: Int -> DescribeStream -> ShowS # show :: DescribeStream -> String # showList :: [DescribeStream] -> ShowS #
Generic DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Associated Types type Rep DescribeStream :: Type -> Type # Methods from :: DescribeStream -> Rep DescribeStream x # to :: Rep DescribeStream x -> DescribeStream #
NFData DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods rnf :: DescribeStream -> () #
Hashable DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods hashWithSalt :: Int -> DescribeStream -> Int # hash :: DescribeStream -> Int #
ToJSON DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods toJSON :: DescribeStream -> Value # toEncoding :: DescribeStream -> Encoding # toJSONList :: [DescribeStream] -> Value # toEncodingList :: [DescribeStream] -> Encoding #
AWSPager DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods page :: DescribeStream -> AWSResponse DescribeStream -> Maybe DescribeStream #
AWSRequest DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Associated Types type AWSResponse DescribeStream # Methods request :: DescribeStream -> Request DescribeStream # response :: MonadResource m => Logger -> Service -> Proxy DescribeStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStream))) #
ToHeaders DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods toHeaders :: DescribeStream -> [Header] #
ToPath DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods toPath :: DescribeStream -> ByteString #
ToQuery DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods toQuery :: DescribeStream -> QueryString #
type Rep DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream type Rep DescribeStream = D1 ('MetaData "DescribeStream" "Amazonka.Kinesis.DescribeStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveStartShardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeStream Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream type AWSResponse DescribeStream = DescribeStreamResponse

newDescribeStream Source #

Arguments

:: Text	`$sel:streamName:DescribeStream'`
-> DescribeStream

Create a value of DescribeStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exclusiveStartShardId:DescribeStream', describeStream_exclusiveStartShardId - The shard ID of the shard to start with.

$sel:limit:DescribeStream', describeStream_limit - The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

$sel:streamName:DescribeStream', describeStream_streamName - The name of the stream to describe.

data DescribeStreamResponse Source #

Represents the output for DescribeStream.

See: newDescribeStreamResponse smart constructor.

Constructors

DescribeStreamResponse' Int StreamDescription

Instances

Instances details

Eq DescribeStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods (==) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool # (/=) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool #
Read DescribeStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods readsPrec :: Int -> ReadS DescribeStreamResponse # readList :: ReadS [DescribeStreamResponse] # readPrec :: ReadPrec DescribeStreamResponse # readListPrec :: ReadPrec [DescribeStreamResponse] #
Show DescribeStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods showsPrec :: Int -> DescribeStreamResponse -> ShowS # show :: DescribeStreamResponse -> String # showList :: [DescribeStreamResponse] -> ShowS #
Generic DescribeStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Associated Types type Rep DescribeStreamResponse :: Type -> Type # Methods from :: DescribeStreamResponse -> Rep DescribeStreamResponse x # to :: Rep DescribeStreamResponse x -> DescribeStreamResponse #
NFData DescribeStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream Methods rnf :: DescribeStreamResponse -> () #
type Rep DescribeStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeStream type Rep DescribeStreamResponse = D1 ('MetaData "DescribeStreamResponse" "Amazonka.Kinesis.DescribeStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "streamDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamDescription)))

newDescribeStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeStreamResponse'`
-> StreamDescription	`$sel:streamDescription:DescribeStreamResponse'`
-> DescribeStreamResponse

Create a value of DescribeStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeStreamResponse', describeStreamResponse_httpStatus - The response's http status code.

$sel:streamDescription:DescribeStreamResponse', describeStreamResponse_streamDescription - The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.

Types

ConsumerStatus

newtype ConsumerStatus Source #

Constructors

ConsumerStatus'
Fields fromConsumerStatus :: Text

Bundled Patterns

pattern ConsumerStatus_ACTIVE :: ConsumerStatus
pattern ConsumerStatus_CREATING :: ConsumerStatus
pattern ConsumerStatus_DELETING :: ConsumerStatus

Instances

Instances details

Eq ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods (==) :: ConsumerStatus -> ConsumerStatus -> Bool # (/=) :: ConsumerStatus -> ConsumerStatus -> Bool #
Ord ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods compare :: ConsumerStatus -> ConsumerStatus -> Ordering # (<) :: ConsumerStatus -> ConsumerStatus -> Bool # (<=) :: ConsumerStatus -> ConsumerStatus -> Bool # (>) :: ConsumerStatus -> ConsumerStatus -> Bool # (>=) :: ConsumerStatus -> ConsumerStatus -> Bool # max :: ConsumerStatus -> ConsumerStatus -> ConsumerStatus # min :: ConsumerStatus -> ConsumerStatus -> ConsumerStatus #
Read ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods readsPrec :: Int -> ReadS ConsumerStatus # readList :: ReadS [ConsumerStatus] # readPrec :: ReadPrec ConsumerStatus # readListPrec :: ReadPrec [ConsumerStatus] #
Show ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods showsPrec :: Int -> ConsumerStatus -> ShowS # show :: ConsumerStatus -> String # showList :: [ConsumerStatus] -> ShowS #
Generic ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Associated Types type Rep ConsumerStatus :: Type -> Type # Methods from :: ConsumerStatus -> Rep ConsumerStatus x # to :: Rep ConsumerStatus x -> ConsumerStatus #
NFData ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods rnf :: ConsumerStatus -> () #
Hashable ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods hashWithSalt :: Int -> ConsumerStatus -> Int # hash :: ConsumerStatus -> Int #
ToJSON ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods toJSON :: ConsumerStatus -> Value # toEncoding :: ConsumerStatus -> Encoding # toJSONList :: [ConsumerStatus] -> Value # toEncodingList :: [ConsumerStatus] -> Encoding #
ToJSONKey ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods toJSONKey :: ToJSONKeyFunction ConsumerStatus # toJSONKeyList :: ToJSONKeyFunction [ConsumerStatus] #
FromJSON ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods parseJSON :: Value -> Parser ConsumerStatus # parseJSONList :: Value -> Parser [ConsumerStatus] #
FromJSONKey ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods fromJSONKey :: FromJSONKeyFunction ConsumerStatus # fromJSONKeyList :: FromJSONKeyFunction [ConsumerStatus] #
ToLog ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods build :: ConsumerStatus -> ByteStringBuilder #
ToHeader ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods toHeader :: HeaderName -> ConsumerStatus -> [Header] #
ToQuery ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods toQuery :: ConsumerStatus -> QueryString #
FromXML ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods parseXML :: [Node] -> Either String ConsumerStatus #
ToXML ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods toXML :: ConsumerStatus -> XML #
ToByteString ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods toBS :: ConsumerStatus -> ByteString #
FromText ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods fromText :: Text -> Either String ConsumerStatus #
ToText ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus Methods toText :: ConsumerStatus -> Text #
type Rep ConsumerStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerStatus type Rep ConsumerStatus = D1 ('MetaData "ConsumerStatus" "Amazonka.Kinesis.Types.ConsumerStatus" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'True) (C1 ('MetaCons "ConsumerStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConsumerStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EncryptionType

newtype EncryptionType Source #

Constructors

EncryptionType'
Fields fromEncryptionType :: Text

Bundled Patterns

pattern EncryptionType_KMS :: EncryptionType
pattern EncryptionType_NONE :: EncryptionType

Instances

Instances details

Eq EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods (==) :: EncryptionType -> EncryptionType -> Bool # (/=) :: EncryptionType -> EncryptionType -> Bool #
Ord EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods compare :: EncryptionType -> EncryptionType -> Ordering # (<) :: EncryptionType -> EncryptionType -> Bool # (<=) :: EncryptionType -> EncryptionType -> Bool # (>) :: EncryptionType -> EncryptionType -> Bool # (>=) :: EncryptionType -> EncryptionType -> Bool # max :: EncryptionType -> EncryptionType -> EncryptionType # min :: EncryptionType -> EncryptionType -> EncryptionType #
Read EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods readsPrec :: Int -> ReadS EncryptionType # readList :: ReadS [EncryptionType] # readPrec :: ReadPrec EncryptionType # readListPrec :: ReadPrec [EncryptionType] #
Show EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods showsPrec :: Int -> EncryptionType -> ShowS # show :: EncryptionType -> String # showList :: [EncryptionType] -> ShowS #
Generic EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Associated Types type Rep EncryptionType :: Type -> Type # Methods from :: EncryptionType -> Rep EncryptionType x # to :: Rep EncryptionType x -> EncryptionType #
NFData EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods rnf :: EncryptionType -> () #
Hashable EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods hashWithSalt :: Int -> EncryptionType -> Int # hash :: EncryptionType -> Int #
ToJSON EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods toJSON :: EncryptionType -> Value # toEncoding :: EncryptionType -> Encoding # toJSONList :: [EncryptionType] -> Value # toEncodingList :: [EncryptionType] -> Encoding #
ToJSONKey EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods toJSONKey :: ToJSONKeyFunction EncryptionType # toJSONKeyList :: ToJSONKeyFunction [EncryptionType] #
FromJSON EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods parseJSON :: Value -> Parser EncryptionType # parseJSONList :: Value -> Parser [EncryptionType] #
FromJSONKey EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods fromJSONKey :: FromJSONKeyFunction EncryptionType # fromJSONKeyList :: FromJSONKeyFunction [EncryptionType] #
ToLog EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods build :: EncryptionType -> ByteStringBuilder #
ToHeader EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods toHeader :: HeaderName -> EncryptionType -> [Header] #
ToQuery EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods toQuery :: EncryptionType -> QueryString #
FromXML EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods parseXML :: [Node] -> Either String EncryptionType #
ToXML EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods toXML :: EncryptionType -> XML #
ToByteString EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods toBS :: EncryptionType -> ByteString #
FromText EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods fromText :: Text -> Either String EncryptionType #
ToText EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType Methods toText :: EncryptionType -> Text #
type Rep EncryptionType Source #
Instance details Defined in Amazonka.Kinesis.Types.EncryptionType type Rep EncryptionType = D1 ('MetaData "EncryptionType" "Amazonka.Kinesis.Types.EncryptionType" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'True) (C1 ('MetaCons "EncryptionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MetricsName

newtype MetricsName Source #

Constructors

MetricsName'
Fields fromMetricsName :: Text

Bundled Patterns

pattern MetricsName_ALL :: MetricsName
pattern MetricsName_IncomingBytes :: MetricsName
pattern MetricsName_IncomingRecords :: MetricsName
pattern MetricsName_IteratorAgeMilliseconds :: MetricsName
pattern MetricsName_OutgoingBytes :: MetricsName
pattern MetricsName_OutgoingRecords :: MetricsName
pattern MetricsName_ReadProvisionedThroughputExceeded :: MetricsName
pattern MetricsName_WriteProvisionedThroughputExceeded :: MetricsName

Instances

Instances details

Eq MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods (==) :: MetricsName -> MetricsName -> Bool # (/=) :: MetricsName -> MetricsName -> Bool #
Ord MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods compare :: MetricsName -> MetricsName -> Ordering # (<) :: MetricsName -> MetricsName -> Bool # (<=) :: MetricsName -> MetricsName -> Bool # (>) :: MetricsName -> MetricsName -> Bool # (>=) :: MetricsName -> MetricsName -> Bool # max :: MetricsName -> MetricsName -> MetricsName # min :: MetricsName -> MetricsName -> MetricsName #
Read MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods readsPrec :: Int -> ReadS MetricsName # readList :: ReadS [MetricsName] # readPrec :: ReadPrec MetricsName # readListPrec :: ReadPrec [MetricsName] #
Show MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods showsPrec :: Int -> MetricsName -> ShowS # show :: MetricsName -> String # showList :: [MetricsName] -> ShowS #
Generic MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Associated Types type Rep MetricsName :: Type -> Type # Methods from :: MetricsName -> Rep MetricsName x # to :: Rep MetricsName x -> MetricsName #
NFData MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods rnf :: MetricsName -> () #
Hashable MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods hashWithSalt :: Int -> MetricsName -> Int # hash :: MetricsName -> Int #
ToJSON MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods toJSON :: MetricsName -> Value # toEncoding :: MetricsName -> Encoding # toJSONList :: [MetricsName] -> Value # toEncodingList :: [MetricsName] -> Encoding #
ToJSONKey MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods toJSONKey :: ToJSONKeyFunction MetricsName # toJSONKeyList :: ToJSONKeyFunction [MetricsName] #
FromJSON MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods parseJSON :: Value -> Parser MetricsName # parseJSONList :: Value -> Parser [MetricsName] #
FromJSONKey MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods fromJSONKey :: FromJSONKeyFunction MetricsName # fromJSONKeyList :: FromJSONKeyFunction [MetricsName] #
ToLog MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods build :: MetricsName -> ByteStringBuilder #
ToHeader MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods toHeader :: HeaderName -> MetricsName -> [Header] #
ToQuery MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods toQuery :: MetricsName -> QueryString #
FromXML MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods parseXML :: [Node] -> Either String MetricsName #
ToXML MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods toXML :: MetricsName -> XML #
ToByteString MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods toBS :: MetricsName -> ByteString #
FromText MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods fromText :: Text -> Either String MetricsName #
ToText MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName Methods toText :: MetricsName -> Text #
type Rep MetricsName Source #
Instance details Defined in Amazonka.Kinesis.Types.MetricsName type Rep MetricsName = D1 ('MetaData "MetricsName" "Amazonka.Kinesis.Types.MetricsName" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'True) (C1 ('MetaCons "MetricsName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMetricsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ScalingType

newtype ScalingType Source #

Constructors

ScalingType'
Fields fromScalingType :: Text

Bundled Patterns

pattern ScalingType_UNIFORM_SCALING :: ScalingType

Instances

Instances details

Eq ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods (==) :: ScalingType -> ScalingType -> Bool # (/=) :: ScalingType -> ScalingType -> Bool #
Ord ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods compare :: ScalingType -> ScalingType -> Ordering # (<) :: ScalingType -> ScalingType -> Bool # (<=) :: ScalingType -> ScalingType -> Bool # (>) :: ScalingType -> ScalingType -> Bool # (>=) :: ScalingType -> ScalingType -> Bool # max :: ScalingType -> ScalingType -> ScalingType # min :: ScalingType -> ScalingType -> ScalingType #
Read ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods readsPrec :: Int -> ReadS ScalingType # readList :: ReadS [ScalingType] # readPrec :: ReadPrec ScalingType # readListPrec :: ReadPrec [ScalingType] #
Show ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods showsPrec :: Int -> ScalingType -> ShowS # show :: ScalingType -> String # showList :: [ScalingType] -> ShowS #
Generic ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Associated Types type Rep ScalingType :: Type -> Type # Methods from :: ScalingType -> Rep ScalingType x # to :: Rep ScalingType x -> ScalingType #
NFData ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods rnf :: ScalingType -> () #
Hashable ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods hashWithSalt :: Int -> ScalingType -> Int # hash :: ScalingType -> Int #
ToJSON ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods toJSON :: ScalingType -> Value # toEncoding :: ScalingType -> Encoding # toJSONList :: [ScalingType] -> Value # toEncodingList :: [ScalingType] -> Encoding #
ToJSONKey ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods toJSONKey :: ToJSONKeyFunction ScalingType # toJSONKeyList :: ToJSONKeyFunction [ScalingType] #
FromJSON ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods parseJSON :: Value -> Parser ScalingType # parseJSONList :: Value -> Parser [ScalingType] #
FromJSONKey ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods fromJSONKey :: FromJSONKeyFunction ScalingType # fromJSONKeyList :: FromJSONKeyFunction [ScalingType] #
ToLog ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods build :: ScalingType -> ByteStringBuilder #
ToHeader ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods toHeader :: HeaderName -> ScalingType -> [Header] #
ToQuery ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods toQuery :: ScalingType -> QueryString #
FromXML ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods parseXML :: [Node] -> Either String ScalingType #
ToXML ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods toXML :: ScalingType -> XML #
ToByteString ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods toBS :: ScalingType -> ByteString #
FromText ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods fromText :: Text -> Either String ScalingType #
ToText ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType Methods toText :: ScalingType -> Text #
type Rep ScalingType Source #
Instance details Defined in Amazonka.Kinesis.Types.ScalingType type Rep ScalingType = D1 ('MetaData "ScalingType" "Amazonka.Kinesis.Types.ScalingType" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'True) (C1 ('MetaCons "ScalingType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromScalingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ShardFilterType

newtype ShardFilterType Source #

Constructors

ShardFilterType'
Fields fromShardFilterType :: Text

Bundled Patterns

pattern ShardFilterType_AFTER_SHARD_ID :: ShardFilterType
pattern ShardFilterType_AT_LATEST :: ShardFilterType
pattern ShardFilterType_AT_TIMESTAMP :: ShardFilterType
pattern ShardFilterType_AT_TRIM_HORIZON :: ShardFilterType
pattern ShardFilterType_FROM_TIMESTAMP :: ShardFilterType
pattern ShardFilterType_FROM_TRIM_HORIZON :: ShardFilterType

Instances

Instances details

Eq ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods (==) :: ShardFilterType -> ShardFilterType -> Bool # (/=) :: ShardFilterType -> ShardFilterType -> Bool #
Ord ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods compare :: ShardFilterType -> ShardFilterType -> Ordering # (<) :: ShardFilterType -> ShardFilterType -> Bool # (<=) :: ShardFilterType -> ShardFilterType -> Bool # (>) :: ShardFilterType -> ShardFilterType -> Bool # (>=) :: ShardFilterType -> ShardFilterType -> Bool # max :: ShardFilterType -> ShardFilterType -> ShardFilterType # min :: ShardFilterType -> ShardFilterType -> ShardFilterType #
Read ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods readsPrec :: Int -> ReadS ShardFilterType # readList :: ReadS [ShardFilterType] # readPrec :: ReadPrec ShardFilterType # readListPrec :: ReadPrec [ShardFilterType] #
Show ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods showsPrec :: Int -> ShardFilterType -> ShowS # show :: ShardFilterType -> String # showList :: [ShardFilterType] -> ShowS #
Generic ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Associated Types type Rep ShardFilterType :: Type -> Type # Methods from :: ShardFilterType -> Rep ShardFilterType x # to :: Rep ShardFilterType x -> ShardFilterType #
NFData ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods rnf :: ShardFilterType -> () #
Hashable ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods hashWithSalt :: Int -> ShardFilterType -> Int # hash :: ShardFilterType -> Int #
ToJSON ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods toJSON :: ShardFilterType -> Value # toEncoding :: ShardFilterType -> Encoding # toJSONList :: [ShardFilterType] -> Value # toEncodingList :: [ShardFilterType] -> Encoding #
ToJSONKey ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods toJSONKey :: ToJSONKeyFunction ShardFilterType # toJSONKeyList :: ToJSONKeyFunction [ShardFilterType] #
FromJSON ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods parseJSON :: Value -> Parser ShardFilterType # parseJSONList :: Value -> Parser [ShardFilterType] #
FromJSONKey ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods fromJSONKey :: FromJSONKeyFunction ShardFilterType # fromJSONKeyList :: FromJSONKeyFunction [ShardFilterType] #
ToLog ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods build :: ShardFilterType -> ByteStringBuilder #
ToHeader ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods toHeader :: HeaderName -> ShardFilterType -> [Header] #
ToQuery ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods toQuery :: ShardFilterType -> QueryString #
FromXML ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods parseXML :: [Node] -> Either String ShardFilterType #
ToXML ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods toXML :: ShardFilterType -> XML #
ToByteString ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods toBS :: ShardFilterType -> ByteString #
FromText ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods fromText :: Text -> Either String ShardFilterType #
ToText ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType Methods toText :: ShardFilterType -> Text #
type Rep ShardFilterType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilterType type Rep ShardFilterType = D1 ('MetaData "ShardFilterType" "Amazonka.Kinesis.Types.ShardFilterType" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'True) (C1 ('MetaCons "ShardFilterType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromShardFilterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ShardIteratorType

newtype ShardIteratorType Source #

Constructors

ShardIteratorType'
Fields fromShardIteratorType :: Text

Bundled Patterns

pattern ShardIteratorType_AFTER_SEQUENCE_NUMBER :: ShardIteratorType
pattern ShardIteratorType_AT_SEQUENCE_NUMBER :: ShardIteratorType
pattern ShardIteratorType_AT_TIMESTAMP :: ShardIteratorType
pattern ShardIteratorType_LATEST :: ShardIteratorType
pattern ShardIteratorType_TRIM_HORIZON :: ShardIteratorType

Instances

Instances details

Eq ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods (==) :: ShardIteratorType -> ShardIteratorType -> Bool # (/=) :: ShardIteratorType -> ShardIteratorType -> Bool #
Ord ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods compare :: ShardIteratorType -> ShardIteratorType -> Ordering # (<) :: ShardIteratorType -> ShardIteratorType -> Bool # (<=) :: ShardIteratorType -> ShardIteratorType -> Bool # (>) :: ShardIteratorType -> ShardIteratorType -> Bool # (>=) :: ShardIteratorType -> ShardIteratorType -> Bool # max :: ShardIteratorType -> ShardIteratorType -> ShardIteratorType # min :: ShardIteratorType -> ShardIteratorType -> ShardIteratorType #
Read ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods readsPrec :: Int -> ReadS ShardIteratorType # readList :: ReadS [ShardIteratorType] # readPrec :: ReadPrec ShardIteratorType # readListPrec :: ReadPrec [ShardIteratorType] #
Show ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods showsPrec :: Int -> ShardIteratorType -> ShowS # show :: ShardIteratorType -> String # showList :: [ShardIteratorType] -> ShowS #
Generic ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Associated Types type Rep ShardIteratorType :: Type -> Type # Methods from :: ShardIteratorType -> Rep ShardIteratorType x # to :: Rep ShardIteratorType x -> ShardIteratorType #
NFData ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods rnf :: ShardIteratorType -> () #
Hashable ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods hashWithSalt :: Int -> ShardIteratorType -> Int # hash :: ShardIteratorType -> Int #
ToJSON ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods toJSON :: ShardIteratorType -> Value # toEncoding :: ShardIteratorType -> Encoding # toJSONList :: [ShardIteratorType] -> Value # toEncodingList :: [ShardIteratorType] -> Encoding #
ToJSONKey ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods toJSONKey :: ToJSONKeyFunction ShardIteratorType # toJSONKeyList :: ToJSONKeyFunction [ShardIteratorType] #
FromJSON ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods parseJSON :: Value -> Parser ShardIteratorType # parseJSONList :: Value -> Parser [ShardIteratorType] #
FromJSONKey ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods fromJSONKey :: FromJSONKeyFunction ShardIteratorType # fromJSONKeyList :: FromJSONKeyFunction [ShardIteratorType] #
ToLog ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods build :: ShardIteratorType -> ByteStringBuilder #
ToHeader ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods toHeader :: HeaderName -> ShardIteratorType -> [Header] #
ToQuery ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods toQuery :: ShardIteratorType -> QueryString #
FromXML ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods parseXML :: [Node] -> Either String ShardIteratorType #
ToXML ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods toXML :: ShardIteratorType -> XML #
ToByteString ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods toBS :: ShardIteratorType -> ByteString #
FromText ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods fromText :: Text -> Either String ShardIteratorType #
ToText ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType Methods toText :: ShardIteratorType -> Text #
type Rep ShardIteratorType Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardIteratorType type Rep ShardIteratorType = D1 ('MetaData "ShardIteratorType" "Amazonka.Kinesis.Types.ShardIteratorType" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'True) (C1 ('MetaCons "ShardIteratorType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromShardIteratorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

StreamStatus

newtype StreamStatus Source #

Constructors

StreamStatus'
Fields fromStreamStatus :: Text

Bundled Patterns

pattern StreamStatus_ACTIVE :: StreamStatus
pattern StreamStatus_CREATING :: StreamStatus
pattern StreamStatus_DELETING :: StreamStatus
pattern StreamStatus_UPDATING :: StreamStatus

Instances

Instances details

Eq StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods (==) :: StreamStatus -> StreamStatus -> Bool # (/=) :: StreamStatus -> StreamStatus -> Bool #
Ord StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods compare :: StreamStatus -> StreamStatus -> Ordering # (<) :: StreamStatus -> StreamStatus -> Bool # (<=) :: StreamStatus -> StreamStatus -> Bool # (>) :: StreamStatus -> StreamStatus -> Bool # (>=) :: StreamStatus -> StreamStatus -> Bool # max :: StreamStatus -> StreamStatus -> StreamStatus # min :: StreamStatus -> StreamStatus -> StreamStatus #
Read StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods readsPrec :: Int -> ReadS StreamStatus # readList :: ReadS [StreamStatus] # readPrec :: ReadPrec StreamStatus # readListPrec :: ReadPrec [StreamStatus] #
Show StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods showsPrec :: Int -> StreamStatus -> ShowS # show :: StreamStatus -> String # showList :: [StreamStatus] -> ShowS #
Generic StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Associated Types type Rep StreamStatus :: Type -> Type # Methods from :: StreamStatus -> Rep StreamStatus x # to :: Rep StreamStatus x -> StreamStatus #
NFData StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods rnf :: StreamStatus -> () #
Hashable StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods hashWithSalt :: Int -> StreamStatus -> Int # hash :: StreamStatus -> Int #
ToJSON StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods toJSON :: StreamStatus -> Value # toEncoding :: StreamStatus -> Encoding # toJSONList :: [StreamStatus] -> Value # toEncodingList :: [StreamStatus] -> Encoding #
ToJSONKey StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods toJSONKey :: ToJSONKeyFunction StreamStatus # toJSONKeyList :: ToJSONKeyFunction [StreamStatus] #
FromJSON StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods parseJSON :: Value -> Parser StreamStatus # parseJSONList :: Value -> Parser [StreamStatus] #
FromJSONKey StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods fromJSONKey :: FromJSONKeyFunction StreamStatus # fromJSONKeyList :: FromJSONKeyFunction [StreamStatus] #
ToLog StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods build :: StreamStatus -> ByteStringBuilder #
ToHeader StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods toHeader :: HeaderName -> StreamStatus -> [Header] #
ToQuery StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods toQuery :: StreamStatus -> QueryString #
FromXML StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods parseXML :: [Node] -> Either String StreamStatus #
ToXML StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods toXML :: StreamStatus -> XML #
ToByteString StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods toBS :: StreamStatus -> ByteString #
FromText StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods fromText :: Text -> Either String StreamStatus #
ToText StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus Methods toText :: StreamStatus -> Text #
type Rep StreamStatus Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamStatus type Rep StreamStatus = D1 ('MetaData "StreamStatus" "Amazonka.Kinesis.Types.StreamStatus" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'True) (C1 ('MetaCons "StreamStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ChildShard

data ChildShard Source #

See: newChildShard smart constructor.

Constructors

ChildShard' Text [Text] HashKeyRange

Instances

Instances details

Eq ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard Methods (==) :: ChildShard -> ChildShard -> Bool # (/=) :: ChildShard -> ChildShard -> Bool #
Read ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard Methods readsPrec :: Int -> ReadS ChildShard # readList :: ReadS [ChildShard] # readPrec :: ReadPrec ChildShard # readListPrec :: ReadPrec [ChildShard] #
Show ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard Methods showsPrec :: Int -> ChildShard -> ShowS # show :: ChildShard -> String # showList :: [ChildShard] -> ShowS #
Generic ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard Associated Types type Rep ChildShard :: Type -> Type # Methods from :: ChildShard -> Rep ChildShard x # to :: Rep ChildShard x -> ChildShard #
NFData ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard Methods rnf :: ChildShard -> () #
Hashable ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard Methods hashWithSalt :: Int -> ChildShard -> Int # hash :: ChildShard -> Int #
FromJSON ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard Methods parseJSON :: Value -> Parser ChildShard # parseJSONList :: Value -> Parser [ChildShard] #
type Rep ChildShard Source #
Instance details Defined in Amazonka.Kinesis.Types.ChildShard type Rep ChildShard = D1 ('MetaData "ChildShard" "Amazonka.Kinesis.Types.ChildShard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ChildShard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "parentShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "hashKeyRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HashKeyRange))))

newChildShard Source #

Arguments

:: Text	`$sel:shardId:ChildShard'`
-> HashKeyRange	`$sel:hashKeyRange:ChildShard'`
-> ChildShard

Create a value of ChildShard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shardId:ChildShard', childShard_shardId - Undocumented member.

$sel:parentShards:ChildShard', childShard_parentShards - Undocumented member.

$sel:hashKeyRange:ChildShard', childShard_hashKeyRange - Undocumented member.

Consumer

data Consumer Source #

An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.

See: newConsumer smart constructor.

Constructors

Consumer' Text Text ConsumerStatus POSIX

Instances

Instances details

Eq Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods (==) :: Consumer -> Consumer -> Bool # (/=) :: Consumer -> Consumer -> Bool #
Read Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods readsPrec :: Int -> ReadS Consumer # readList :: ReadS [Consumer] # readPrec :: ReadPrec Consumer # readListPrec :: ReadPrec [Consumer] #
Show Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods showsPrec :: Int -> Consumer -> ShowS # show :: Consumer -> String # showList :: [Consumer] -> ShowS #
Generic Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Associated Types type Rep Consumer :: Type -> Type # Methods from :: Consumer -> Rep Consumer x # to :: Rep Consumer x -> Consumer #
NFData Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods rnf :: Consumer -> () #
Hashable Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods hashWithSalt :: Int -> Consumer -> Int # hash :: Consumer -> Int #
FromJSON Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods parseJSON :: Value -> Parser Consumer # parseJSONList :: Value -> Parser [Consumer] #
type Rep Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer type Rep Consumer = D1 ('MetaData "Consumer" "Amazonka.Kinesis.Types.Consumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "Consumer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "consumerStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConsumerStatus) :*: S1 ('MetaSel ('Just "consumerCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newConsumer Source #

Arguments

:: Text	`$sel:consumerName:Consumer'`
-> Text	`$sel:consumerARN:Consumer'`
-> ConsumerStatus	`$sel:consumerStatus:Consumer'`
-> UTCTime	`$sel:consumerCreationTimestamp:Consumer'`
-> Consumer

Create a value of Consumer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:consumerName:Consumer', consumer_consumerName - The name of the consumer is something you choose when you register the consumer.

$sel:consumerARN:Consumer', consumer_consumerARN - When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

$sel:consumerStatus:Consumer', consumer_consumerStatus - A consumer can't read data while in the CREATING or DELETING states.

$sel:consumerCreationTimestamp:Consumer', consumer_consumerCreationTimestamp -

ConsumerDescription

data ConsumerDescription Source #

An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

See: newConsumerDescription smart constructor.

Constructors

ConsumerDescription' Text Text ConsumerStatus POSIX Text

Instances

Instances details

Eq ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription Methods (==) :: ConsumerDescription -> ConsumerDescription -> Bool # (/=) :: ConsumerDescription -> ConsumerDescription -> Bool #
Read ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription Methods readsPrec :: Int -> ReadS ConsumerDescription # readList :: ReadS [ConsumerDescription] # readPrec :: ReadPrec ConsumerDescription # readListPrec :: ReadPrec [ConsumerDescription] #
Show ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription Methods showsPrec :: Int -> ConsumerDescription -> ShowS # show :: ConsumerDescription -> String # showList :: [ConsumerDescription] -> ShowS #
Generic ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription Associated Types type Rep ConsumerDescription :: Type -> Type # Methods from :: ConsumerDescription -> Rep ConsumerDescription x # to :: Rep ConsumerDescription x -> ConsumerDescription #
NFData ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription Methods rnf :: ConsumerDescription -> () #
Hashable ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription Methods hashWithSalt :: Int -> ConsumerDescription -> Int # hash :: ConsumerDescription -> Int #
FromJSON ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription Methods parseJSON :: Value -> Parser ConsumerDescription # parseJSONList :: Value -> Parser [ConsumerDescription] #
type Rep ConsumerDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.ConsumerDescription type Rep ConsumerDescription = D1 ('MetaData "ConsumerDescription" "Amazonka.Kinesis.Types.ConsumerDescription" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ConsumerDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "consumerStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConsumerStatus) :: (S1 ('MetaSel ('Just "consumerCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newConsumerDescription Source #

Arguments

:: Text	`$sel:consumerName:ConsumerDescription'`
-> Text	`$sel:consumerARN:ConsumerDescription'`
-> ConsumerStatus	`$sel:consumerStatus:ConsumerDescription'`
-> UTCTime	`$sel:consumerCreationTimestamp:ConsumerDescription'`
-> Text	`$sel:streamARN:ConsumerDescription'`
-> ConsumerDescription

Create a value of ConsumerDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:consumerName:ConsumerDescription', consumerDescription_consumerName - The name of the consumer is something you choose when you register the consumer.

$sel:consumerARN:ConsumerDescription', consumerDescription_consumerARN - When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

$sel:consumerStatus:ConsumerDescription', consumerDescription_consumerStatus - A consumer can't read data while in the CREATING or DELETING states.

$sel:consumerCreationTimestamp:ConsumerDescription', consumerDescription_consumerCreationTimestamp -

$sel:streamARN:ConsumerDescription', consumerDescription_streamARN - The ARN of the stream with which you registered the consumer.

EnhancedMetrics

data EnhancedMetrics Source #

Represents enhanced metrics types.

See: newEnhancedMetrics smart constructor.

Constructors

EnhancedMetrics' (Maybe [MetricsName])

Instances

Instances details

Eq EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics Methods (==) :: EnhancedMetrics -> EnhancedMetrics -> Bool # (/=) :: EnhancedMetrics -> EnhancedMetrics -> Bool #
Read EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics Methods readsPrec :: Int -> ReadS EnhancedMetrics # readList :: ReadS [EnhancedMetrics] # readPrec :: ReadPrec EnhancedMetrics # readListPrec :: ReadPrec [EnhancedMetrics] #
Show EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics Methods showsPrec :: Int -> EnhancedMetrics -> ShowS # show :: EnhancedMetrics -> String # showList :: [EnhancedMetrics] -> ShowS #
Generic EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics Associated Types type Rep EnhancedMetrics :: Type -> Type # Methods from :: EnhancedMetrics -> Rep EnhancedMetrics x # to :: Rep EnhancedMetrics x -> EnhancedMetrics #
NFData EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics Methods rnf :: EnhancedMetrics -> () #
Hashable EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics Methods hashWithSalt :: Int -> EnhancedMetrics -> Int # hash :: EnhancedMetrics -> Int #
FromJSON EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics Methods parseJSON :: Value -> Parser EnhancedMetrics # parseJSONList :: Value -> Parser [EnhancedMetrics] #
type Rep EnhancedMetrics Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMetrics type Rep EnhancedMetrics = D1 ('MetaData "EnhancedMetrics" "Amazonka.Kinesis.Types.EnhancedMetrics" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "EnhancedMetrics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName]))))

newEnhancedMetrics :: EnhancedMetrics Source #

Create a value of EnhancedMetrics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shardLevelMetrics:EnhancedMetrics', enhancedMetrics_shardLevelMetrics - List of shard-level metrics.

The following are the valid shard-level metrics. The value "ALL" enhances every metric.

```
IncomingBytes
```
```
IncomingRecords
```
```
OutgoingBytes
```
```
OutgoingRecords
```
```
WriteProvisionedThroughputExceeded
```
```
ReadProvisionedThroughputExceeded
```
```
IteratorAgeMilliseconds
```
```
ALL
```

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

EnhancedMonitoringOutput

data EnhancedMonitoringOutput Source #

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

See: newEnhancedMonitoringOutput smart constructor.

Constructors

EnhancedMonitoringOutput' (Maybe [MetricsName]) (Maybe [MetricsName]) (Maybe Text)

Instances

Instances details

Eq EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods (==) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool # (/=) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool #
Read EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods readsPrec :: Int -> ReadS EnhancedMonitoringOutput # readList :: ReadS [EnhancedMonitoringOutput] # readPrec :: ReadPrec EnhancedMonitoringOutput # readListPrec :: ReadPrec [EnhancedMonitoringOutput] #
Show EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods showsPrec :: Int -> EnhancedMonitoringOutput -> ShowS # show :: EnhancedMonitoringOutput -> String # showList :: [EnhancedMonitoringOutput] -> ShowS #
Generic EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Associated Types type Rep EnhancedMonitoringOutput :: Type -> Type # Methods from :: EnhancedMonitoringOutput -> Rep EnhancedMonitoringOutput x # to :: Rep EnhancedMonitoringOutput x -> EnhancedMonitoringOutput #
NFData EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods rnf :: EnhancedMonitoringOutput -> () #
Hashable EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods hashWithSalt :: Int -> EnhancedMonitoringOutput -> Int # hash :: EnhancedMonitoringOutput -> Int #
FromJSON EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput Methods parseJSON :: Value -> Parser EnhancedMonitoringOutput # parseJSONList :: Value -> Parser [EnhancedMonitoringOutput] #
type Rep EnhancedMonitoringOutput Source #
Instance details Defined in Amazonka.Kinesis.Types.EnhancedMonitoringOutput type Rep EnhancedMonitoringOutput = D1 ('MetaData "EnhancedMonitoringOutput" "Amazonka.Kinesis.Types.EnhancedMonitoringOutput" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "EnhancedMonitoringOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "desiredShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: (S1 ('MetaSel ('Just "currentShardLevelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricsName])) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEnhancedMonitoringOutput :: EnhancedMonitoringOutput Source #

Create a value of EnhancedMonitoringOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:desiredShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_desiredShardLevelMetrics - Represents the list of all the metrics that would be in the enhanced state after the operation.

$sel:currentShardLevelMetrics:EnhancedMonitoringOutput', enhancedMonitoringOutput_currentShardLevelMetrics - Represents the current state of the metrics that are in the enhanced state before the operation.

$sel:streamName:EnhancedMonitoringOutput', enhancedMonitoringOutput_streamName - The name of the Kinesis data stream.

HashKeyRange

data HashKeyRange Source #

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

See: newHashKeyRange smart constructor.

Constructors

HashKeyRange' Text Text

Instances

Instances details

Eq HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange Methods (==) :: HashKeyRange -> HashKeyRange -> Bool # (/=) :: HashKeyRange -> HashKeyRange -> Bool #
Read HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange Methods readsPrec :: Int -> ReadS HashKeyRange # readList :: ReadS [HashKeyRange] # readPrec :: ReadPrec HashKeyRange # readListPrec :: ReadPrec [HashKeyRange] #
Show HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange Methods showsPrec :: Int -> HashKeyRange -> ShowS # show :: HashKeyRange -> String # showList :: [HashKeyRange] -> ShowS #
Generic HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange Associated Types type Rep HashKeyRange :: Type -> Type # Methods from :: HashKeyRange -> Rep HashKeyRange x # to :: Rep HashKeyRange x -> HashKeyRange #
NFData HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange Methods rnf :: HashKeyRange -> () #
Hashable HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange Methods hashWithSalt :: Int -> HashKeyRange -> Int # hash :: HashKeyRange -> Int #
FromJSON HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange Methods parseJSON :: Value -> Parser HashKeyRange # parseJSONList :: Value -> Parser [HashKeyRange] #
type Rep HashKeyRange Source #
Instance details Defined in Amazonka.Kinesis.Types.HashKeyRange type Rep HashKeyRange = D1 ('MetaData "HashKeyRange" "Amazonka.Kinesis.Types.HashKeyRange" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "HashKeyRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "startingHashKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endingHashKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newHashKeyRange Source #

Arguments

:: Text	`$sel:startingHashKey:HashKeyRange'`
-> Text	`$sel:endingHashKey:HashKeyRange'`
-> HashKeyRange

Create a value of HashKeyRange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:startingHashKey:HashKeyRange', hashKeyRange_startingHashKey - The starting hash key of the hash key range.

$sel:endingHashKey:HashKeyRange', hashKeyRange_endingHashKey - The ending hash key of the hash key range.

PutRecordsRequestEntry

data PutRecordsRequestEntry Source #

Represents the output for PutRecords.

See: newPutRecordsRequestEntry smart constructor.

Constructors

PutRecordsRequestEntry' (Maybe Text) Base64 Text

Instances

Instances details

Eq PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry Methods (==) :: PutRecordsRequestEntry -> PutRecordsRequestEntry -> Bool # (/=) :: PutRecordsRequestEntry -> PutRecordsRequestEntry -> Bool #
Read PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry Methods readsPrec :: Int -> ReadS PutRecordsRequestEntry # readList :: ReadS [PutRecordsRequestEntry] # readPrec :: ReadPrec PutRecordsRequestEntry # readListPrec :: ReadPrec [PutRecordsRequestEntry] #
Show PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry Methods showsPrec :: Int -> PutRecordsRequestEntry -> ShowS # show :: PutRecordsRequestEntry -> String # showList :: [PutRecordsRequestEntry] -> ShowS #
Generic PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry Associated Types type Rep PutRecordsRequestEntry :: Type -> Type # Methods from :: PutRecordsRequestEntry -> Rep PutRecordsRequestEntry x # to :: Rep PutRecordsRequestEntry x -> PutRecordsRequestEntry #
NFData PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry Methods rnf :: PutRecordsRequestEntry -> () #
Hashable PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry Methods hashWithSalt :: Int -> PutRecordsRequestEntry -> Int # hash :: PutRecordsRequestEntry -> Int #
ToJSON PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry Methods toJSON :: PutRecordsRequestEntry -> Value # toEncoding :: PutRecordsRequestEntry -> Encoding # toJSONList :: [PutRecordsRequestEntry] -> Value # toEncodingList :: [PutRecordsRequestEntry] -> Encoding #
type Rep PutRecordsRequestEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry type Rep PutRecordsRequestEntry = D1 ('MetaData "PutRecordsRequestEntry" "Amazonka.Kinesis.Types.PutRecordsRequestEntry" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "PutRecordsRequestEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "explicitHashKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :: S1 ('MetaSel ('Just "partitionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutRecordsRequestEntry Source #

Arguments

:: ByteString	`$sel:data':PutRecordsRequestEntry'`
-> Text	`$sel:partitionKey:PutRecordsRequestEntry'`
-> PutRecordsRequestEntry

Create a value of PutRecordsRequestEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:explicitHashKey:PutRecordsRequestEntry', putRecordsRequestEntry_explicitHashKey - The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

$sel:data':PutRecordsRequestEntry', putRecordsRequestEntry_data - The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MiB).-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:partitionKey:PutRecordsRequestEntry', putRecordsRequestEntry_partitionKey - Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

PutRecordsResultEntry

data PutRecordsResultEntry Source #

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

See: newPutRecordsResultEntry smart constructor.

Constructors

PutRecordsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry Methods (==) :: PutRecordsResultEntry -> PutRecordsResultEntry -> Bool # (/=) :: PutRecordsResultEntry -> PutRecordsResultEntry -> Bool #
Read PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry Methods readsPrec :: Int -> ReadS PutRecordsResultEntry # readList :: ReadS [PutRecordsResultEntry] # readPrec :: ReadPrec PutRecordsResultEntry # readListPrec :: ReadPrec [PutRecordsResultEntry] #
Show PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry Methods showsPrec :: Int -> PutRecordsResultEntry -> ShowS # show :: PutRecordsResultEntry -> String # showList :: [PutRecordsResultEntry] -> ShowS #
Generic PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry Associated Types type Rep PutRecordsResultEntry :: Type -> Type # Methods from :: PutRecordsResultEntry -> Rep PutRecordsResultEntry x # to :: Rep PutRecordsResultEntry x -> PutRecordsResultEntry #
NFData PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry Methods rnf :: PutRecordsResultEntry -> () #
Hashable PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry Methods hashWithSalt :: Int -> PutRecordsResultEntry -> Int # hash :: PutRecordsResultEntry -> Int #
FromJSON PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry Methods parseJSON :: Value -> Parser PutRecordsResultEntry # parseJSONList :: Value -> Parser [PutRecordsResultEntry] #
type Rep PutRecordsResultEntry Source #
Instance details Defined in Amazonka.Kinesis.Types.PutRecordsResultEntry type Rep PutRecordsResultEntry = D1 ('MetaData "PutRecordsResultEntry" "Amazonka.Kinesis.Types.PutRecordsResultEntry" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "PutRecordsResultEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPutRecordsResultEntry :: PutRecordsResultEntry Source #

Create a value of PutRecordsResultEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sequenceNumber:PutRecordsResultEntry', putRecordsResultEntry_sequenceNumber - The sequence number for an individual record result.

$sel:errorCode:PutRecordsResultEntry', putRecordsResultEntry_errorCode - The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

$sel:errorMessage:PutRecordsResultEntry', putRecordsResultEntry_errorMessage - The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

$sel:shardId:PutRecordsResultEntry', putRecordsResultEntry_shardId - The shard ID for an individual record result.

Record

data Record Source #

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

See: newRecord smart constructor.

Constructors

Record' (Maybe EncryptionType) (Maybe POSIX) Text Base64 Text

Instances

Instances details

Eq Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record Methods (==) :: Record -> Record -> Bool # (/=) :: Record -> Record -> Bool #
Read Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record Methods readsPrec :: Int -> ReadS Record # readList :: ReadS [Record] # readPrec :: ReadPrec Record # readListPrec :: ReadPrec [Record] #
Show Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record Methods showsPrec :: Int -> Record -> ShowS # show :: Record -> String # showList :: [Record] -> ShowS #
Generic Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record Associated Types type Rep Record :: Type -> Type # Methods from :: Record -> Rep Record x # to :: Rep Record x -> Record #
NFData Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record Methods rnf :: Record -> () #
Hashable Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record Methods hashWithSalt :: Int -> Record -> Int # hash :: Record -> Int #
FromJSON Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record Methods parseJSON :: Value -> Parser Record # parseJSONList :: Value -> Parser [Record] #
type Rep Record Source #
Instance details Defined in Amazonka.Kinesis.Types.Record type Rep Record = D1 ('MetaData "Record" "Amazonka.Kinesis.Types.Record" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "Record'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionType)) :: S1 ('MetaSel ('Just "approximateArrivalTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "sequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :: S1 ('MetaSel ('Just "partitionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRecord Source #

Arguments

:: Text	`$sel:sequenceNumber:Record'`
-> ByteString	`$sel:data':Record'`
-> Text	`$sel:partitionKey:Record'`
-> Record

Create a value of Record with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionType:Record', record_encryptionType - The encryption type used on the record. This parameter can be one of the following values:

NONE: Do not encrypt the records in the stream.
KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

$sel:approximateArrivalTimestamp:Record', record_approximateArrivalTimestamp - The approximate time that the record was inserted into the stream.

$sel:sequenceNumber:Record', record_sequenceNumber - The unique identifier of the record within its shard.

$sel:data':Record', record_data - The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MiB).-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:partitionKey:Record', record_partitionKey - Identifies which shard in the stream the data record is assigned to.

SequenceNumberRange

data SequenceNumberRange Source #

The range of possible sequence numbers for the shard.

See: newSequenceNumberRange smart constructor.

Constructors

SequenceNumberRange' (Maybe Text) Text

Instances

Instances details

Eq SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange Methods (==) :: SequenceNumberRange -> SequenceNumberRange -> Bool # (/=) :: SequenceNumberRange -> SequenceNumberRange -> Bool #
Read SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange Methods readsPrec :: Int -> ReadS SequenceNumberRange # readList :: ReadS [SequenceNumberRange] # readPrec :: ReadPrec SequenceNumberRange # readListPrec :: ReadPrec [SequenceNumberRange] #
Show SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange Methods showsPrec :: Int -> SequenceNumberRange -> ShowS # show :: SequenceNumberRange -> String # showList :: [SequenceNumberRange] -> ShowS #
Generic SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange Associated Types type Rep SequenceNumberRange :: Type -> Type # Methods from :: SequenceNumberRange -> Rep SequenceNumberRange x # to :: Rep SequenceNumberRange x -> SequenceNumberRange #
NFData SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange Methods rnf :: SequenceNumberRange -> () #
Hashable SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange Methods hashWithSalt :: Int -> SequenceNumberRange -> Int # hash :: SequenceNumberRange -> Int #
FromJSON SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange Methods parseJSON :: Value -> Parser SequenceNumberRange # parseJSONList :: Value -> Parser [SequenceNumberRange] #
type Rep SequenceNumberRange Source #
Instance details Defined in Amazonka.Kinesis.Types.SequenceNumberRange type Rep SequenceNumberRange = D1 ('MetaData "SequenceNumberRange" "Amazonka.Kinesis.Types.SequenceNumberRange" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SequenceNumberRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endingSequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startingSequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSequenceNumberRange Source #

Arguments

:: Text	`$sel:startingSequenceNumber:SequenceNumberRange'`
-> SequenceNumberRange

Create a value of SequenceNumberRange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endingSequenceNumber:SequenceNumberRange', sequenceNumberRange_endingSequenceNumber - The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

$sel:startingSequenceNumber:SequenceNumberRange', sequenceNumberRange_startingSequenceNumber - The starting sequence number for the range.

Shard

data Shard Source #

A uniquely identified group of data records in a Kinesis data stream.

See: newShard smart constructor.

Constructors

Shard' (Maybe Text) (Maybe Text) Text HashKeyRange SequenceNumberRange

Instances

Instances details

Eq Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard Methods (==) :: Shard -> Shard -> Bool # (/=) :: Shard -> Shard -> Bool #
Read Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard Methods readsPrec :: Int -> ReadS Shard # readList :: ReadS [Shard] # readPrec :: ReadPrec Shard # readListPrec :: ReadPrec [Shard] #
Show Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard Methods showsPrec :: Int -> Shard -> ShowS # show :: Shard -> String # showList :: [Shard] -> ShowS #
Generic Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard Associated Types type Rep Shard :: Type -> Type # Methods from :: Shard -> Rep Shard x # to :: Rep Shard x -> Shard #
NFData Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard Methods rnf :: Shard -> () #
Hashable Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard Methods hashWithSalt :: Int -> Shard -> Int # hash :: Shard -> Int #
FromJSON Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard Methods parseJSON :: Value -> Parser Shard # parseJSONList :: Value -> Parser [Shard] #
type Rep Shard Source #
Instance details Defined in Amazonka.Kinesis.Types.Shard type Rep Shard = D1 ('MetaData "Shard" "Amazonka.Kinesis.Types.Shard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "Shard'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "adjacentParentShardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentShardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "hashKeyRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HashKeyRange) :: S1 ('MetaSel ('Just "sequenceNumberRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SequenceNumberRange)))))

newShard Source #

Arguments

:: Text	`$sel:shardId:Shard'`
-> HashKeyRange	`$sel:hashKeyRange:Shard'`
-> SequenceNumberRange	`$sel:sequenceNumberRange:Shard'`
-> Shard

Create a value of Shard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:adjacentParentShardId:Shard', shard_adjacentParentShardId - The shard ID of the shard adjacent to the shard's parent.

$sel:parentShardId:Shard', shard_parentShardId - The shard ID of the shard's parent.

$sel:shardId:Shard', shard_shardId - The unique identifier of the shard within the stream.

$sel:hashKeyRange:Shard', shard_hashKeyRange - The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

$sel:sequenceNumberRange:Shard', shard_sequenceNumberRange - The range of possible sequence numbers for the shard.

ShardFilter

data ShardFilter Source #

See: newShardFilter smart constructor.

Constructors

ShardFilter' (Maybe POSIX) (Maybe Text) ShardFilterType

Instances

Instances details

Eq ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods (==) :: ShardFilter -> ShardFilter -> Bool # (/=) :: ShardFilter -> ShardFilter -> Bool #
Read ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods readsPrec :: Int -> ReadS ShardFilter # readList :: ReadS [ShardFilter] # readPrec :: ReadPrec ShardFilter # readListPrec :: ReadPrec [ShardFilter] #
Show ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods showsPrec :: Int -> ShardFilter -> ShowS # show :: ShardFilter -> String # showList :: [ShardFilter] -> ShowS #
Generic ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Associated Types type Rep ShardFilter :: Type -> Type # Methods from :: ShardFilter -> Rep ShardFilter x # to :: Rep ShardFilter x -> ShardFilter #
NFData ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods rnf :: ShardFilter -> () #
Hashable ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods hashWithSalt :: Int -> ShardFilter -> Int # hash :: ShardFilter -> Int #
ToJSON ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter Methods toJSON :: ShardFilter -> Value # toEncoding :: ShardFilter -> Encoding # toJSONList :: [ShardFilter] -> Value # toEncodingList :: [ShardFilter] -> Encoding #
type Rep ShardFilter Source #
Instance details Defined in Amazonka.Kinesis.Types.ShardFilter type Rep ShardFilter = D1 ('MetaData "ShardFilter" "Amazonka.Kinesis.Types.ShardFilter" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ShardFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "shardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShardFilterType))))

newShardFilter Source #

Arguments

:: ShardFilterType	`$sel:type':ShardFilter'`
-> ShardFilter

Create a value of ShardFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:timestamp:ShardFilter', shardFilter_timestamp - Undocumented member.

$sel:shardId:ShardFilter', shardFilter_shardId - Undocumented member.

$sel:type':ShardFilter', shardFilter_type - Undocumented member.

StartingPosition

data StartingPosition Source #

See: newStartingPosition smart constructor.

Constructors

StartingPosition' (Maybe Text) (Maybe POSIX) ShardIteratorType

Instances

Instances details

Eq StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods (==) :: StartingPosition -> StartingPosition -> Bool # (/=) :: StartingPosition -> StartingPosition -> Bool #
Read StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods readsPrec :: Int -> ReadS StartingPosition # readList :: ReadS [StartingPosition] # readPrec :: ReadPrec StartingPosition # readListPrec :: ReadPrec [StartingPosition] #
Show StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods showsPrec :: Int -> StartingPosition -> ShowS # show :: StartingPosition -> String # showList :: [StartingPosition] -> ShowS #
Generic StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Associated Types type Rep StartingPosition :: Type -> Type # Methods from :: StartingPosition -> Rep StartingPosition x # to :: Rep StartingPosition x -> StartingPosition #
NFData StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods rnf :: StartingPosition -> () #
Hashable StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods hashWithSalt :: Int -> StartingPosition -> Int # hash :: StartingPosition -> Int #
ToJSON StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods toJSON :: StartingPosition -> Value # toEncoding :: StartingPosition -> Encoding # toJSONList :: [StartingPosition] -> Value # toEncodingList :: [StartingPosition] -> Encoding #
type Rep StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition type Rep StartingPosition = D1 ('MetaData "StartingPosition" "Amazonka.Kinesis.Types.StartingPosition" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StartingPosition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShardIteratorType))))

newStartingPosition Source #

Arguments

:: ShardIteratorType	`$sel:type':StartingPosition'`
-> StartingPosition

Create a value of StartingPosition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sequenceNumber:StartingPosition', startingPosition_sequenceNumber - The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

$sel:timestamp:StartingPosition', startingPosition_timestamp - The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON).

$sel:type':StartingPosition', startingPosition_type - You can set the starting position to one of the following values:

AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.

TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.

StreamDescription

data StreamDescription Source #

Represents the output for DescribeStream.

See: newStreamDescription smart constructor.

Constructors

StreamDescription' (Maybe EncryptionType) (Maybe Text) Text Text StreamStatus [Shard] Bool Int POSIX [EnhancedMetrics]

Instances

Instances details

Eq StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription Methods (==) :: StreamDescription -> StreamDescription -> Bool # (/=) :: StreamDescription -> StreamDescription -> Bool #
Read StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription Methods readsPrec :: Int -> ReadS StreamDescription # readList :: ReadS [StreamDescription] # readPrec :: ReadPrec StreamDescription # readListPrec :: ReadPrec [StreamDescription] #
Show StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription Methods showsPrec :: Int -> StreamDescription -> ShowS # show :: StreamDescription -> String # showList :: [StreamDescription] -> ShowS #
Generic StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription Associated Types type Rep StreamDescription :: Type -> Type # Methods from :: StreamDescription -> Rep StreamDescription x # to :: Rep StreamDescription x -> StreamDescription #
NFData StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription Methods rnf :: StreamDescription -> () #
Hashable StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription Methods hashWithSalt :: Int -> StreamDescription -> Int # hash :: StreamDescription -> Int #
FromJSON StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription Methods parseJSON :: Value -> Parser StreamDescription # parseJSONList :: Value -> Parser [StreamDescription] #
type Rep StreamDescription Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescription type Rep StreamDescription = D1 ('MetaData "StreamDescription" "Amazonka.Kinesis.Types.StreamDescription" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StreamDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionType)) :: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "streamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamStatus)))) :: ((S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Shard]) :: S1 ('MetaSel ('Just "hasMoreShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "retentionPeriodHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "streamCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "enhancedMonitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EnhancedMetrics]))))))

newStreamDescription Source #

Arguments

:: Text	`$sel:streamName:StreamDescription'`
-> Text	`$sel:streamARN:StreamDescription'`
-> StreamStatus	`$sel:streamStatus:StreamDescription'`
-> Bool	`$sel:hasMoreShards:StreamDescription'`
-> Int	`$sel:retentionPeriodHours:StreamDescription'`
-> UTCTime	`$sel:streamCreationTimestamp:StreamDescription'`
-> StreamDescription

Create a value of StreamDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionType:StreamDescription', streamDescription_encryptionType - The server-side encryption type used on the stream. This parameter can be one of the following values:

NONE: Do not encrypt the records in the stream.
KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

$sel:keyId:StreamDescription', streamDescription_keyId - The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis

$sel:streamName:StreamDescription', streamDescription_streamName - The name of the stream being described.

$sel:streamARN:StreamDescription', streamDescription_streamARN - The Amazon Resource Name (ARN) for the stream being described.

$sel:streamStatus:StreamDescription', streamDescription_streamStatus - The current status of the stream being described. The stream status is one of the following states:

CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.
DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

$sel:shards:StreamDescription', streamDescription_shards - The shards that comprise the stream.

$sel:hasMoreShards:StreamDescription', streamDescription_hasMoreShards - If set to true, more shards in the stream are available to describe.

$sel:retentionPeriodHours:StreamDescription', streamDescription_retentionPeriodHours - The current retention period, in hours. Minimum value of 24. Maximum value of 168.

$sel:streamCreationTimestamp:StreamDescription', streamDescription_streamCreationTimestamp - The approximate time that the stream was created.

$sel:enhancedMonitoring:StreamDescription', streamDescription_enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.

StreamDescriptionSummary

data StreamDescriptionSummary Source #

Represents the output for DescribeStreamSummary

See: newStreamDescriptionSummary smart constructor.

Constructors

StreamDescriptionSummary' (Maybe EncryptionType) (Maybe Text) (Maybe Natural) Text Text StreamStatus Int POSIX [EnhancedMetrics] Natural

Instances

Instances details

Eq StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary Methods (==) :: StreamDescriptionSummary -> StreamDescriptionSummary -> Bool # (/=) :: StreamDescriptionSummary -> StreamDescriptionSummary -> Bool #
Read StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary Methods readsPrec :: Int -> ReadS StreamDescriptionSummary # readList :: ReadS [StreamDescriptionSummary] # readPrec :: ReadPrec StreamDescriptionSummary # readListPrec :: ReadPrec [StreamDescriptionSummary] #
Show StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary Methods showsPrec :: Int -> StreamDescriptionSummary -> ShowS # show :: StreamDescriptionSummary -> String # showList :: [StreamDescriptionSummary] -> ShowS #
Generic StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary Associated Types type Rep StreamDescriptionSummary :: Type -> Type # Methods from :: StreamDescriptionSummary -> Rep StreamDescriptionSummary x # to :: Rep StreamDescriptionSummary x -> StreamDescriptionSummary #
NFData StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary Methods rnf :: StreamDescriptionSummary -> () #
Hashable StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary Methods hashWithSalt :: Int -> StreamDescriptionSummary -> Int # hash :: StreamDescriptionSummary -> Int #
FromJSON StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary Methods parseJSON :: Value -> Parser StreamDescriptionSummary # parseJSONList :: Value -> Parser [StreamDescriptionSummary] #
type Rep StreamDescriptionSummary Source #
Instance details Defined in Amazonka.Kinesis.Types.StreamDescriptionSummary type Rep StreamDescriptionSummary = D1 ('MetaData "StreamDescriptionSummary" "Amazonka.Kinesis.Types.StreamDescriptionSummary" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StreamDescriptionSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionType)) :: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "consumerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "streamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamStatus) :: S1 ('MetaSel ('Just "retentionPeriodHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "streamCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "enhancedMonitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EnhancedMetrics]) :*: S1 ('MetaSel ('Just "openShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))))

newStreamDescriptionSummary Source #

Arguments

:: Text	`$sel:streamName:StreamDescriptionSummary'`
-> Text	`$sel:streamARN:StreamDescriptionSummary'`
-> StreamStatus	`$sel:streamStatus:StreamDescriptionSummary'`
-> Int	`$sel:retentionPeriodHours:StreamDescriptionSummary'`
-> UTCTime	`$sel:streamCreationTimestamp:StreamDescriptionSummary'`
-> Natural	`$sel:openShardCount:StreamDescriptionSummary'`
-> StreamDescriptionSummary

Create a value of StreamDescriptionSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionType:StreamDescriptionSummary', streamDescriptionSummary_encryptionType - The encryption type used. This value is one of the following:

```
KMS
```
```
NONE
```

$sel:keyId:StreamDescriptionSummary', streamDescriptionSummary_keyId - The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis

$sel:consumerCount:StreamDescriptionSummary', streamDescriptionSummary_consumerCount - The number of enhanced fan-out consumers registered with the stream.

$sel:streamName:StreamDescriptionSummary', streamDescriptionSummary_streamName - The name of the stream being described.

$sel:streamARN:StreamDescriptionSummary', streamDescriptionSummary_streamARN - The Amazon Resource Name (ARN) for the stream being described.

$sel:streamStatus:StreamDescriptionSummary', streamDescriptionSummary_streamStatus - The current status of the stream being described. The stream status is one of the following states:

CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.
DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

$sel:retentionPeriodHours:StreamDescriptionSummary', streamDescriptionSummary_retentionPeriodHours - The current retention period, in hours.

$sel:streamCreationTimestamp:StreamDescriptionSummary', streamDescriptionSummary_streamCreationTimestamp - The approximate time that the stream was created.

$sel:enhancedMonitoring:StreamDescriptionSummary', streamDescriptionSummary_enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.

$sel:openShardCount:StreamDescriptionSummary', streamDescriptionSummary_openShardCount - The number of open shards in the stream.

SubscribeToShardEvent

data SubscribeToShardEvent Source #

After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.

See: newSubscribeToShardEvent smart constructor.

Constructors

SubscribeToShardEvent' (Maybe [ChildShard]) [Record] Text Natural

Instances

Instances details

Eq SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods (==) :: SubscribeToShardEvent -> SubscribeToShardEvent -> Bool # (/=) :: SubscribeToShardEvent -> SubscribeToShardEvent -> Bool #
Read SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods readsPrec :: Int -> ReadS SubscribeToShardEvent # readList :: ReadS [SubscribeToShardEvent] # readPrec :: ReadPrec SubscribeToShardEvent # readListPrec :: ReadPrec [SubscribeToShardEvent] #
Show SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods showsPrec :: Int -> SubscribeToShardEvent -> ShowS # show :: SubscribeToShardEvent -> String # showList :: [SubscribeToShardEvent] -> ShowS #
Generic SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Associated Types type Rep SubscribeToShardEvent :: Type -> Type # Methods from :: SubscribeToShardEvent -> Rep SubscribeToShardEvent x # to :: Rep SubscribeToShardEvent x -> SubscribeToShardEvent #
NFData SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods rnf :: SubscribeToShardEvent -> () #
Hashable SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods hashWithSalt :: Int -> SubscribeToShardEvent -> Int # hash :: SubscribeToShardEvent -> Int #
FromJSON SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods parseJSON :: Value -> Parser SubscribeToShardEvent # parseJSONList :: Value -> Parser [SubscribeToShardEvent] #
type Rep SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent type Rep SubscribeToShardEvent = D1 ('MetaData "SubscribeToShardEvent" "Amazonka.Kinesis.Types.SubscribeToShardEvent" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SubscribeToShardEvent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "childShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChildShard])) :: S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Record])) :: (S1 ('MetaSel ('Just "continuationSequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "millisBehindLatest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newSubscribeToShardEvent Source #

Arguments

:: Text	`$sel:continuationSequenceNumber:SubscribeToShardEvent'`
-> Natural	`$sel:millisBehindLatest:SubscribeToShardEvent'`
-> SubscribeToShardEvent

Create a value of SubscribeToShardEvent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:childShards:SubscribeToShardEvent', subscribeToShardEvent_childShards - Undocumented member.

$sel:records:SubscribeToShardEvent', subscribeToShardEvent_records -

$sel:continuationSequenceNumber:SubscribeToShardEvent', subscribeToShardEvent_continuationSequenceNumber - Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

$sel:millisBehindLatest:SubscribeToShardEvent', subscribeToShardEvent_millisBehindLatest - The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

Tag

data Tag Source #

Metadata assigned to the stream, consisting of a key-value pair.

See: newTag smart constructor.

Constructors

Tag' (Maybe Text) Text

Instances

Instances details

Eq Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Read Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
Generic Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
NFData Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag Methods rnf :: Tag -> () #
Hashable Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag Methods hashWithSalt :: Int -> Tag -> Int # hash :: Tag -> Int #
FromJSON Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #
type Rep Tag Source #
Instance details Defined in Amazonka.Kinesis.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Kinesis.Types.Tag" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Arguments

:: Text	`$sel:key:Tag'`
-> Tag

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:Tag', tag_value - An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

$sel:key:Tag', tag_key - A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @