amazonka-kinesis-1.4.5: Amazon Kinesis SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Kinesis.Types

Contents

Description

 

Synopsis

Service Configuration

kinesis :: Service #

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

Errors

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

The provided iterator exceeds the maximum age allowed.

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

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

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

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

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

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

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

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

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

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

MetricsName

data MetricsName #

Instances

Bounded MetricsName # 
Enum MetricsName # 
Eq MetricsName # 
Data MetricsName # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MetricsName -> c MetricsName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MetricsName #

toConstr :: MetricsName -> Constr #

dataTypeOf :: MetricsName -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MetricsName) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MetricsName) #

gmapT :: (forall b. Data b => b -> b) -> MetricsName -> MetricsName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MetricsName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MetricsName -> r #

gmapQ :: (forall d. Data d => d -> u) -> MetricsName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MetricsName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MetricsName -> m MetricsName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MetricsName -> m MetricsName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MetricsName -> m MetricsName #

Ord MetricsName # 
Read MetricsName # 
Show MetricsName # 
Generic MetricsName # 

Associated Types

type Rep MetricsName :: * -> * #

Hashable MetricsName # 
ToJSON MetricsName # 
FromJSON MetricsName # 
NFData MetricsName # 

Methods

rnf :: MetricsName -> () #

ToQuery MetricsName # 
ToHeader MetricsName # 
ToByteString MetricsName # 
FromText MetricsName # 
ToText MetricsName # 

Methods

toText :: MetricsName -> Text #

type Rep MetricsName # 
type Rep MetricsName = D1 (MetaData "MetricsName" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "All" PrefixI False) U1) (C1 (MetaCons "IncomingBytes" PrefixI False) U1)) ((:+:) (C1 (MetaCons "IncomingRecords" PrefixI False) U1) (C1 (MetaCons "IteratorAgeMilliseconds" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "OutgoingBytes" PrefixI False) U1) (C1 (MetaCons "OutgoingRecords" PrefixI False) U1)) ((:+:) (C1 (MetaCons "ReadProvisionedThroughputExceeded" PrefixI False) U1) (C1 (MetaCons "WriteProvisionedThroughputExceeded" PrefixI False) U1))))

ScalingType

data ScalingType #

Constructors

UniformScaling 

Instances

Bounded ScalingType # 
Enum ScalingType # 
Eq ScalingType # 
Data ScalingType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ScalingType -> c ScalingType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ScalingType #

toConstr :: ScalingType -> Constr #

dataTypeOf :: ScalingType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ScalingType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ScalingType) #

gmapT :: (forall b. Data b => b -> b) -> ScalingType -> ScalingType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ScalingType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ScalingType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ScalingType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ScalingType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ScalingType -> m ScalingType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ScalingType -> m ScalingType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ScalingType -> m ScalingType #

Ord ScalingType # 
Read ScalingType # 
Show ScalingType # 
Generic ScalingType # 

Associated Types

type Rep ScalingType :: * -> * #

Hashable ScalingType # 
ToJSON ScalingType # 
NFData ScalingType # 

Methods

rnf :: ScalingType -> () #

ToQuery ScalingType # 
ToHeader ScalingType # 
ToByteString ScalingType # 
FromText ScalingType # 
ToText ScalingType # 

Methods

toText :: ScalingType -> Text #

type Rep ScalingType # 
type Rep ScalingType = D1 (MetaData "ScalingType" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "UniformScaling" PrefixI False) U1)

ShardIteratorType

data ShardIteratorType #

Instances

Bounded ShardIteratorType # 
Enum ShardIteratorType # 
Eq ShardIteratorType # 
Data ShardIteratorType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ShardIteratorType -> c ShardIteratorType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ShardIteratorType #

toConstr :: ShardIteratorType -> Constr #

dataTypeOf :: ShardIteratorType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ShardIteratorType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ShardIteratorType) #

gmapT :: (forall b. Data b => b -> b) -> ShardIteratorType -> ShardIteratorType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ShardIteratorType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ShardIteratorType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ShardIteratorType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ShardIteratorType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ShardIteratorType -> m ShardIteratorType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ShardIteratorType -> m ShardIteratorType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ShardIteratorType -> m ShardIteratorType #

Ord ShardIteratorType # 
Read ShardIteratorType # 
Show ShardIteratorType # 
Generic ShardIteratorType # 
Hashable ShardIteratorType # 
ToJSON ShardIteratorType # 
NFData ShardIteratorType # 

Methods

rnf :: ShardIteratorType -> () #

ToQuery ShardIteratorType # 
ToHeader ShardIteratorType # 
ToByteString ShardIteratorType # 
FromText ShardIteratorType # 
ToText ShardIteratorType # 
type Rep ShardIteratorType # 
type Rep ShardIteratorType = D1 (MetaData "ShardIteratorType" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) ((:+:) ((:+:) (C1 (MetaCons "AfterSequenceNumber" PrefixI False) U1) (C1 (MetaCons "AtSequenceNumber" PrefixI False) U1)) ((:+:) (C1 (MetaCons "AtTimestamp" PrefixI False) U1) ((:+:) (C1 (MetaCons "Latest" PrefixI False) U1) (C1 (MetaCons "TrimHorizon" PrefixI False) U1))))

StreamStatus

data StreamStatus #

Constructors

Active 
Creating 
Deleting 
Updating 

Instances

Bounded StreamStatus # 
Enum StreamStatus # 
Eq StreamStatus # 
Data StreamStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StreamStatus -> c StreamStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StreamStatus #

toConstr :: StreamStatus -> Constr #

dataTypeOf :: StreamStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StreamStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StreamStatus) #

gmapT :: (forall b. Data b => b -> b) -> StreamStatus -> StreamStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StreamStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StreamStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> StreamStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StreamStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StreamStatus -> m StreamStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamStatus -> m StreamStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamStatus -> m StreamStatus #

Ord StreamStatus # 
Read StreamStatus # 
Show StreamStatus # 
Generic StreamStatus # 

Associated Types

type Rep StreamStatus :: * -> * #

Hashable StreamStatus # 
FromJSON StreamStatus # 
NFData StreamStatus # 

Methods

rnf :: StreamStatus -> () #

ToQuery StreamStatus # 
ToHeader StreamStatus # 
ToByteString StreamStatus # 
FromText StreamStatus # 
ToText StreamStatus # 

Methods

toText :: StreamStatus -> Text #

type Rep StreamStatus # 
type Rep StreamStatus = D1 (MetaData "StreamStatus" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) ((:+:) ((:+:) (C1 (MetaCons "Active" PrefixI False) U1) (C1 (MetaCons "Creating" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Deleting" PrefixI False) U1) (C1 (MetaCons "Updating" PrefixI False) U1)))

EnhancedMetrics

data EnhancedMetrics #

Represents enhanced metrics types.

See: enhancedMetrics smart constructor.

Instances

Eq EnhancedMetrics # 
Data EnhancedMetrics # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnhancedMetrics -> c EnhancedMetrics #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnhancedMetrics #

toConstr :: EnhancedMetrics -> Constr #

dataTypeOf :: EnhancedMetrics -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EnhancedMetrics) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnhancedMetrics) #

gmapT :: (forall b. Data b => b -> b) -> EnhancedMetrics -> EnhancedMetrics #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnhancedMetrics -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnhancedMetrics -> r #

gmapQ :: (forall d. Data d => d -> u) -> EnhancedMetrics -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EnhancedMetrics -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnhancedMetrics -> m EnhancedMetrics #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnhancedMetrics -> m EnhancedMetrics #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnhancedMetrics -> m EnhancedMetrics #

Read EnhancedMetrics # 
Show EnhancedMetrics # 
Generic EnhancedMetrics # 
Hashable EnhancedMetrics # 
FromJSON EnhancedMetrics # 
NFData EnhancedMetrics # 

Methods

rnf :: EnhancedMetrics -> () #

type Rep EnhancedMetrics # 
type Rep EnhancedMetrics = D1 (MetaData "EnhancedMetrics" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" True) (C1 (MetaCons "EnhancedMetrics'" PrefixI True) (S1 (MetaSel (Just Symbol "_emShardLevelMetrics") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [MetricsName]))))

enhancedMetrics :: EnhancedMetrics #

Creates a value of EnhancedMetrics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • emShardLevelMetrics - List of shard-level metrics. The following are the valid shard-level metrics. The value "ALL " enhances every metric. * IncomingBytes * IncomingRecords * OutgoingBytes * OutgoingRecords * WriteProvisionedThroughputExceeded * ReadProvisionedThroughputExceeded * IteratorAgeMilliseconds * ALL For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide .

emShardLevelMetrics :: Lens' EnhancedMetrics [MetricsName] #

List of shard-level metrics. The following are the valid shard-level metrics. The value "ALL " enhances every metric. * IncomingBytes * IncomingRecords * OutgoingBytes * OutgoingRecords * WriteProvisionedThroughputExceeded * ReadProvisionedThroughputExceeded * IteratorAgeMilliseconds * ALL For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide .

EnhancedMonitoringOutput

data EnhancedMonitoringOutput #

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring .

See: enhancedMonitoringOutput smart constructor.

Instances

Eq EnhancedMonitoringOutput # 
Data EnhancedMonitoringOutput # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnhancedMonitoringOutput -> c EnhancedMonitoringOutput #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnhancedMonitoringOutput #

toConstr :: EnhancedMonitoringOutput -> Constr #

dataTypeOf :: EnhancedMonitoringOutput -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EnhancedMonitoringOutput) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnhancedMonitoringOutput) #

gmapT :: (forall b. Data b => b -> b) -> EnhancedMonitoringOutput -> EnhancedMonitoringOutput #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnhancedMonitoringOutput -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnhancedMonitoringOutput -> r #

gmapQ :: (forall d. Data d => d -> u) -> EnhancedMonitoringOutput -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EnhancedMonitoringOutput -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnhancedMonitoringOutput -> m EnhancedMonitoringOutput #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnhancedMonitoringOutput -> m EnhancedMonitoringOutput #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnhancedMonitoringOutput -> m EnhancedMonitoringOutput #

Read EnhancedMonitoringOutput # 
Show EnhancedMonitoringOutput # 
Generic EnhancedMonitoringOutput # 
Hashable EnhancedMonitoringOutput # 
FromJSON EnhancedMonitoringOutput # 
NFData EnhancedMonitoringOutput # 
type Rep EnhancedMonitoringOutput # 
type Rep EnhancedMonitoringOutput = D1 (MetaData "EnhancedMonitoringOutput" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "EnhancedMonitoringOutput'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_emoDesiredShardLevelMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MetricsName]))) ((:*:) (S1 (MetaSel (Just Symbol "_emoCurrentShardLevelMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MetricsName]))) (S1 (MetaSel (Just Symbol "_emoStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

enhancedMonitoringOutput :: EnhancedMonitoringOutput #

Creates a value of EnhancedMonitoringOutput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName] #

Represents the list of all the metrics that would be in the enhanced state after the operation.

emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName] #

Represents the current state of the metrics that are in the enhanced state before the operation.

emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text) #

The name of the Amazon Kinesis stream.

HashKeyRange

data HashKeyRange #

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

See: hashKeyRange smart constructor.

Instances

Eq HashKeyRange # 
Data HashKeyRange # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HashKeyRange -> c HashKeyRange #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HashKeyRange #

toConstr :: HashKeyRange -> Constr #

dataTypeOf :: HashKeyRange -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c HashKeyRange) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HashKeyRange) #

gmapT :: (forall b. Data b => b -> b) -> HashKeyRange -> HashKeyRange #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HashKeyRange -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HashKeyRange -> r #

gmapQ :: (forall d. Data d => d -> u) -> HashKeyRange -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> HashKeyRange -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> HashKeyRange -> m HashKeyRange #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HashKeyRange -> m HashKeyRange #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HashKeyRange -> m HashKeyRange #

Read HashKeyRange # 
Show HashKeyRange # 
Generic HashKeyRange # 

Associated Types

type Rep HashKeyRange :: * -> * #

Hashable HashKeyRange # 
FromJSON HashKeyRange # 
NFData HashKeyRange # 

Methods

rnf :: HashKeyRange -> () #

type Rep HashKeyRange # 
type Rep HashKeyRange = D1 (MetaData "HashKeyRange" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "HashKeyRange'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_hkrStartingHashKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_hkrEndingHashKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

hashKeyRange #

Creates a value of HashKeyRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

hkrStartingHashKey :: Lens' HashKeyRange Text #

The starting hash key of the hash key range.

hkrEndingHashKey :: Lens' HashKeyRange Text #

The ending hash key of the hash key range.

PutRecordsRequestEntry

data PutRecordsRequestEntry #

Represents the output for PutRecords .

See: putRecordsRequestEntry smart constructor.

Instances

Eq PutRecordsRequestEntry # 
Data PutRecordsRequestEntry # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutRecordsRequestEntry -> c PutRecordsRequestEntry #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutRecordsRequestEntry #

toConstr :: PutRecordsRequestEntry -> Constr #

dataTypeOf :: PutRecordsRequestEntry -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutRecordsRequestEntry) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutRecordsRequestEntry) #

gmapT :: (forall b. Data b => b -> b) -> PutRecordsRequestEntry -> PutRecordsRequestEntry #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordsRequestEntry -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordsRequestEntry -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutRecordsRequestEntry -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutRecordsRequestEntry -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutRecordsRequestEntry -> m PutRecordsRequestEntry #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordsRequestEntry -> m PutRecordsRequestEntry #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordsRequestEntry -> m PutRecordsRequestEntry #

Read PutRecordsRequestEntry # 
Show PutRecordsRequestEntry # 
Generic PutRecordsRequestEntry # 
Hashable PutRecordsRequestEntry # 
ToJSON PutRecordsRequestEntry # 
NFData PutRecordsRequestEntry # 

Methods

rnf :: PutRecordsRequestEntry -> () #

type Rep PutRecordsRequestEntry # 
type Rep PutRecordsRequestEntry = D1 (MetaData "PutRecordsRequestEntry" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "PutRecordsRequestEntry'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_prreExplicitHashKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_prreData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Base64)) (S1 (MetaSel (Just Symbol "_prrePartitionKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

putRecordsRequestEntry #

Creates a value of PutRecordsRequestEntry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • prreExplicitHashKey - The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
  • prreData - The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • prrePartitionKey - Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

prreExplicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text) #

The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

prreData :: Lens' PutRecordsRequestEntry ByteString #

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

prrePartitionKey :: Lens' PutRecordsRequestEntry Text #

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

PutRecordsResultEntry

data PutRecordsResultEntry #

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

See: putRecordsResultEntry smart constructor.

Instances

Eq PutRecordsResultEntry # 
Data PutRecordsResultEntry # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutRecordsResultEntry -> c PutRecordsResultEntry #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutRecordsResultEntry #

toConstr :: PutRecordsResultEntry -> Constr #

dataTypeOf :: PutRecordsResultEntry -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutRecordsResultEntry) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutRecordsResultEntry) #

gmapT :: (forall b. Data b => b -> b) -> PutRecordsResultEntry -> PutRecordsResultEntry #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordsResultEntry -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordsResultEntry -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutRecordsResultEntry -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutRecordsResultEntry -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutRecordsResultEntry -> m PutRecordsResultEntry #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordsResultEntry -> m PutRecordsResultEntry #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordsResultEntry -> m PutRecordsResultEntry #

Read PutRecordsResultEntry # 
Show PutRecordsResultEntry # 
Generic PutRecordsResultEntry # 
Hashable PutRecordsResultEntry # 
FromJSON PutRecordsResultEntry # 
NFData PutRecordsResultEntry # 

Methods

rnf :: PutRecordsResultEntry -> () #

type Rep PutRecordsResultEntry # 
type Rep PutRecordsResultEntry = D1 (MetaData "PutRecordsResultEntry" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "PutRecordsResultEntry'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_prreSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_prreErrorCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_prreErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_prreShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

putRecordsResultEntry :: PutRecordsResultEntry #

Creates a value of PutRecordsResultEntry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • prreSequenceNumber - The sequence number for an individual record result.
  • prreErrorCode - The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure .
  • prreErrorMessage - The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure" .
  • prreShardId - The shard ID for an individual record result.

prreSequenceNumber :: Lens' PutRecordsResultEntry (Maybe Text) #

The sequence number for an individual record result.

prreErrorCode :: Lens' PutRecordsResultEntry (Maybe Text) #

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure .

prreErrorMessage :: Lens' PutRecordsResultEntry (Maybe Text) #

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure" .

prreShardId :: Lens' PutRecordsResultEntry (Maybe Text) #

The shard ID for an individual record result.

Record

data Record #

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

See: record smart constructor.

Instances

Eq Record # 

Methods

(==) :: Record -> Record -> Bool #

(/=) :: Record -> Record -> Bool #

Data Record # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Record -> c Record #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Record #

toConstr :: Record -> Constr #

dataTypeOf :: Record -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Record) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Record) #

gmapT :: (forall b. Data b => b -> b) -> Record -> Record #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Record -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Record -> r #

gmapQ :: (forall d. Data d => d -> u) -> Record -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Record -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Record -> m Record #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Record -> m Record #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Record -> m Record #

Read Record # 
Show Record # 
Generic Record # 

Associated Types

type Rep Record :: * -> * #

Methods

from :: Record -> Rep Record x #

to :: Rep Record x -> Record #

Hashable Record # 

Methods

hashWithSalt :: Int -> Record -> Int #

hash :: Record -> Int #

FromJSON Record # 
NFData Record # 

Methods

rnf :: Record -> () #

type Rep Record # 
type Rep Record = D1 (MetaData "Record" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "Record'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rApproximateArrivalTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_rSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Base64)) (S1 (MetaSel (Just Symbol "_rPartitionKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

record #

Creates a value of Record with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • rApproximateArrivalTimestamp - The approximate time that the record was inserted into the stream.
  • rSequenceNumber - The unique identifier of the record in the stream.
  • rData - The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • rPartitionKey - Identifies which shard in the stream the data record is assigned to.

rApproximateArrivalTimestamp :: Lens' Record (Maybe UTCTime) #

The approximate time that the record was inserted into the stream.

rSequenceNumber :: Lens' Record Text #

The unique identifier of the record in the stream.

rData :: Lens' Record ByteString #

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

rPartitionKey :: Lens' Record Text #

Identifies which shard in the stream the data record is assigned to.

SequenceNumberRange

data SequenceNumberRange #

The range of possible sequence numbers for the shard.

See: sequenceNumberRange smart constructor.

Instances

Eq SequenceNumberRange # 
Data SequenceNumberRange # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SequenceNumberRange -> c SequenceNumberRange #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SequenceNumberRange #

toConstr :: SequenceNumberRange -> Constr #

dataTypeOf :: SequenceNumberRange -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SequenceNumberRange) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SequenceNumberRange) #

gmapT :: (forall b. Data b => b -> b) -> SequenceNumberRange -> SequenceNumberRange #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SequenceNumberRange -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SequenceNumberRange -> r #

gmapQ :: (forall d. Data d => d -> u) -> SequenceNumberRange -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SequenceNumberRange -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SequenceNumberRange -> m SequenceNumberRange #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SequenceNumberRange -> m SequenceNumberRange #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SequenceNumberRange -> m SequenceNumberRange #

Read SequenceNumberRange # 
Show SequenceNumberRange # 
Generic SequenceNumberRange # 
Hashable SequenceNumberRange # 
FromJSON SequenceNumberRange # 
NFData SequenceNumberRange # 

Methods

rnf :: SequenceNumberRange -> () #

type Rep SequenceNumberRange # 
type Rep SequenceNumberRange = D1 (MetaData "SequenceNumberRange" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "SequenceNumberRange'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_snrEndingSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_snrStartingSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

sequenceNumberRange #

Creates a value of SequenceNumberRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text) #

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null .

snrStartingSequenceNumber :: Lens' SequenceNumberRange Text #

The starting sequence number for the range.

Shard

data Shard #

A uniquely identified group of data records in an Amazon Kinesis stream.

See: shard smart constructor.

Instances

Eq Shard # 

Methods

(==) :: Shard -> Shard -> Bool #

(/=) :: Shard -> Shard -> Bool #

Data Shard # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Shard -> c Shard #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Shard #

toConstr :: Shard -> Constr #

dataTypeOf :: Shard -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Shard) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Shard) #

gmapT :: (forall b. Data b => b -> b) -> Shard -> Shard #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Shard -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Shard -> r #

gmapQ :: (forall d. Data d => d -> u) -> Shard -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Shard -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Shard -> m Shard #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Shard -> m Shard #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Shard -> m Shard #

Read Shard # 
Show Shard # 

Methods

showsPrec :: Int -> Shard -> ShowS #

show :: Shard -> String #

showList :: [Shard] -> ShowS #

Generic Shard # 

Associated Types

type Rep Shard :: * -> * #

Methods

from :: Shard -> Rep Shard x #

to :: Rep Shard x -> Shard #

Hashable Shard # 

Methods

hashWithSalt :: Int -> Shard -> Int #

hash :: Shard -> Int #

FromJSON Shard # 
NFData Shard # 

Methods

rnf :: Shard -> () #

type Rep Shard # 
type Rep Shard = D1 (MetaData "Shard" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "Shard'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sAdjacentParentShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sParentShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_sHashKeyRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HashKeyRange)) (S1 (MetaSel (Just Symbol "_sSequenceNumberRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SequenceNumberRange))))))

shard #

Creates a value of Shard with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sAdjacentParentShardId - The shard ID of the shard adjacent to the shard's parent.
  • sParentShardId - The shard ID of the shard's parent.
  • sShardId - The unique identifier of the shard within the stream.
  • sHashKeyRange - The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
  • sSequenceNumberRange - The range of possible sequence numbers for the shard.

sAdjacentParentShardId :: Lens' Shard (Maybe Text) #

The shard ID of the shard adjacent to the shard's parent.

sParentShardId :: Lens' Shard (Maybe Text) #

The shard ID of the shard's parent.

sShardId :: Lens' Shard Text #

The unique identifier of the shard within the stream.

sHashKeyRange :: Lens' Shard HashKeyRange #

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

sSequenceNumberRange :: Lens' Shard SequenceNumberRange #

The range of possible sequence numbers for the shard.

StreamDescription

data StreamDescription #

Represents the output for DescribeStream .

See: streamDescription smart constructor.

Instances

Eq StreamDescription # 
Data StreamDescription # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StreamDescription -> c StreamDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StreamDescription #

toConstr :: StreamDescription -> Constr #

dataTypeOf :: StreamDescription -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StreamDescription) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StreamDescription) #

gmapT :: (forall b. Data b => b -> b) -> StreamDescription -> StreamDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StreamDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StreamDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> StreamDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StreamDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StreamDescription -> m StreamDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamDescription -> m StreamDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamDescription -> m StreamDescription #

Read StreamDescription # 
Show StreamDescription # 
Generic StreamDescription # 
Hashable StreamDescription # 
FromJSON StreamDescription # 
NFData StreamDescription # 

Methods

rnf :: StreamDescription -> () #

type Rep StreamDescription # 
type Rep StreamDescription = D1 (MetaData "StreamDescription" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "StreamDescription'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sdStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sdStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sdStreamStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StreamStatus)) (S1 (MetaSel (Just Symbol "_sdShards") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Shard])))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sdHasMoreShards") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_sdRetentionPeriodHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_sdStreamCreationTimestamp") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 POSIX)) (S1 (MetaSel (Just Symbol "_sdEnhancedMonitoring") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [EnhancedMetrics]))))))

streamDescription #

Creates a value of StreamDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sdStreamName - The name of the stream being described.
  • sdStreamARN - The Amazon Resource Name (ARN) for the stream being described.
  • sdStreamStatus - The current status of the stream being described. The stream status is one of the following states: * CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING . * DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion. * ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream. * UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
  • sdShards - The shards that comprise the stream.
  • sdHasMoreShards - If set to true , more shards in the stream are available to describe.
  • sdRetentionPeriodHours - The current retention period, in hours.
  • sdStreamCreationTimestamp - The approximate time that the stream was created.
  • sdEnhancedMonitoring - Represents the current enhanced monitoring settings of the stream.

sdStreamName :: Lens' StreamDescription Text #

The name of the stream being described.

sdStreamARN :: Lens' StreamDescription Text #

The Amazon Resource Name (ARN) for the stream being described.

sdStreamStatus :: Lens' StreamDescription StreamStatus #

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

sdShards :: Lens' StreamDescription [Shard] #

The shards that comprise the stream.

sdHasMoreShards :: Lens' StreamDescription Bool #

If set to true , more shards in the stream are available to describe.

sdRetentionPeriodHours :: Lens' StreamDescription Natural #

The current retention period, in hours.

sdStreamCreationTimestamp :: Lens' StreamDescription UTCTime #

The approximate time that the stream was created.

sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics] #

Represents the current enhanced monitoring settings of the stream.

Tag

data Tag #

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

See: tag smart constructor.

Instances

Eq Tag # 

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Data Tag # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag #

toConstr :: Tag -> Constr #

dataTypeOf :: Tag -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Tag) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) #

gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r #

gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

Read Tag # 
Show Tag # 

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag # 

Associated Types

type Rep Tag :: * -> * #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Hashable Tag # 

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

FromJSON Tag # 
NFData Tag # 

Methods

rnf :: Tag -> () #

type Rep Tag # 
type Rep Tag = D1 (MetaData "Tag" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "Tag'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

tag #

Arguments

:: Text

tagKey

-> Tag 

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • tagValue - An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
  • tagKey - A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

tagValue :: Lens' Tag (Maybe Text) #

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

tagKey :: Lens' Tag Text #

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