Network.AWS.Kinesis

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.

Service Configuration

kinesis :: Service

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

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

KMSThrottlingException

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

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

ExpiredIteratorException

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

The provided iterator exceeds the maximum age allowed.

InvalidArgumentException

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

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

KMSOptInRequired

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

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

ProvisionedThroughputExceededException

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

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

KMSNotFoundException

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

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

ExpiredNextTokenException

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

The pagination token passed to the ListShards operation is expired. For more information, see 'ListShardsInput$NextToken' .

KMSDisabledException

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

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

ResourceNotFoundException

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

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

KMSAccessDeniedException

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

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

LimitExceededException

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

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

ResourceInUseException

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

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

Waiters

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

StreamExists

streamExists :: Wait DescribeStream

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

StreamNotExists

streamNotExists :: Wait DescribeStream

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

Operations

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

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

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

PutRecord

module Network.AWS.Kinesis.PutRecord

DecreaseStreamRetentionPeriod

module Network.AWS.Kinesis.DecreaseStreamRetentionPeriod

MergeShards

module Network.AWS.Kinesis.MergeShards

DescribeStreamSummary

module Network.AWS.Kinesis.DescribeStreamSummary

GetShardIterator

module Network.AWS.Kinesis.GetShardIterator

GetRecords

module Network.AWS.Kinesis.GetRecords

StopStreamEncryption

module Network.AWS.Kinesis.StopStreamEncryption

EnableEnhancedMonitoring

module Network.AWS.Kinesis.EnableEnhancedMonitoring

DescribeLimits

module Network.AWS.Kinesis.DescribeLimits

DisableEnhancedMonitoring

module Network.AWS.Kinesis.DisableEnhancedMonitoring

UpdateShardCount

module Network.AWS.Kinesis.UpdateShardCount

ListTagsForStream

module Network.AWS.Kinesis.ListTagsForStream

AddTagsToStream

module Network.AWS.Kinesis.AddTagsToStream

PutRecords

module Network.AWS.Kinesis.PutRecords

ListShards

module Network.AWS.Kinesis.ListShards

DeleteStream

module Network.AWS.Kinesis.DeleteStream

RemoveTagsFromStream

module Network.AWS.Kinesis.RemoveTagsFromStream

ListStreams (Paginated)

module Network.AWS.Kinesis.ListStreams

CreateStream

module Network.AWS.Kinesis.CreateStream

StartStreamEncryption

module Network.AWS.Kinesis.StartStreamEncryption

SplitShard

module Network.AWS.Kinesis.SplitShard

IncreaseStreamRetentionPeriod

module Network.AWS.Kinesis.IncreaseStreamRetentionPeriod

DescribeStream (Paginated)

module Network.AWS.Kinesis.DescribeStream

Types

EncryptionType

data EncryptionType

Constructors

KMS

None

Instances

Bounded EncryptionType

Methods

minBound :: EncryptionType

maxBound :: EncryptionType

Enum EncryptionType

Methods

succ :: EncryptionType -> EncryptionType

pred :: EncryptionType -> EncryptionType

toEnum :: Int -> EncryptionType

fromEnum :: EncryptionType -> Int

enumFrom :: EncryptionType -> [EncryptionType]

enumFromThen :: EncryptionType -> EncryptionType -> [EncryptionType]

enumFromTo :: EncryptionType -> EncryptionType -> [EncryptionType]

enumFromThenTo :: EncryptionType -> EncryptionType -> EncryptionType -> [EncryptionType]

Eq EncryptionType

Methods

(==) :: EncryptionType -> EncryptionType -> Bool

(/=) :: EncryptionType -> EncryptionType -> Bool

Data EncryptionType

Methods

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

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

toConstr :: EncryptionType -> Constr

dataTypeOf :: EncryptionType -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> EncryptionType -> EncryptionType

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

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

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

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

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

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

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

Ord 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

Methods

readsPrec :: Int -> ReadS EncryptionType

readList :: ReadS [EncryptionType]

readPrec :: ReadPrec EncryptionType

readListPrec :: ReadPrec [EncryptionType]

Show EncryptionType

Methods

showsPrec :: Int -> EncryptionType -> ShowS

show :: EncryptionType -> String

showList :: [EncryptionType] -> ShowS

Generic EncryptionType

Associated Types

type Rep EncryptionType :: * -> *

Methods

from :: EncryptionType -> Rep EncryptionType x

to :: Rep EncryptionType x -> EncryptionType

Hashable EncryptionType

Methods

hashWithSalt :: Int -> EncryptionType -> Int

hash :: EncryptionType -> Int

ToJSON EncryptionType

Methods

toJSON :: EncryptionType -> Value

toEncoding :: EncryptionType -> Encoding

toJSONList :: [EncryptionType] -> Value

toEncodingList :: [EncryptionType] -> Encoding

FromJSON EncryptionType

Methods

parseJSON :: Value -> Parser EncryptionType

parseJSONList :: Value -> Parser [EncryptionType]

NFData EncryptionType

Methods

rnf :: EncryptionType -> ()

ToHeader EncryptionType

Methods

toHeader :: HeaderName -> EncryptionType -> [Header]

ToQuery EncryptionType

Methods

toQuery :: EncryptionType -> QueryString

ToByteString EncryptionType

Methods

toBS :: EncryptionType -> ByteString

FromText EncryptionType

Methods

parser :: Parser EncryptionType

ToText EncryptionType

Methods

toText :: EncryptionType -> Text

type Rep EncryptionType

type Rep EncryptionType = D1 * (MetaData "EncryptionType" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) ((:+:) * (C1 * (MetaCons "KMS" PrefixI False) (U1 *)) (C1 * (MetaCons "None" PrefixI False) (U1 *)))

MetricsName

data MetricsName

Constructors

All

IncomingBytes

IncomingRecords

IteratorAgeMilliseconds

OutgoingBytes

OutgoingRecords

ReadProvisionedThroughputExceeded

WriteProvisionedThroughputExceeded

Instances

Bounded MetricsName

Methods

minBound :: MetricsName

maxBound :: MetricsName

Enum MetricsName

Methods

succ :: MetricsName -> MetricsName

pred :: MetricsName -> MetricsName

toEnum :: Int -> MetricsName

fromEnum :: MetricsName -> Int

enumFrom :: MetricsName -> [MetricsName]

enumFromThen :: MetricsName -> MetricsName -> [MetricsName]

enumFromTo :: MetricsName -> MetricsName -> [MetricsName]

enumFromThenTo :: MetricsName -> MetricsName -> MetricsName -> [MetricsName]

Eq MetricsName

Methods

(==) :: MetricsName -> MetricsName -> Bool

(/=) :: MetricsName -> MetricsName -> Bool

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

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

Methods

readsPrec :: Int -> ReadS MetricsName

readList :: ReadS [MetricsName]

readPrec :: ReadPrec MetricsName

readListPrec :: ReadPrec [MetricsName]

Show MetricsName

Methods

showsPrec :: Int -> MetricsName -> ShowS

show :: MetricsName -> String

showList :: [MetricsName] -> ShowS

Generic MetricsName

Associated Types

type Rep MetricsName :: * -> *

Methods

from :: MetricsName -> Rep MetricsName x

to :: Rep MetricsName x -> MetricsName

Hashable MetricsName

Methods

hashWithSalt :: Int -> MetricsName -> Int

hash :: MetricsName -> Int

ToJSON MetricsName

Methods

toJSON :: MetricsName -> Value

toEncoding :: MetricsName -> Encoding

toJSONList :: [MetricsName] -> Value

toEncodingList :: [MetricsName] -> Encoding

FromJSON MetricsName

Methods

parseJSON :: Value -> Parser MetricsName

parseJSONList :: Value -> Parser [MetricsName]

NFData MetricsName

Methods

rnf :: MetricsName -> ()

ToHeader MetricsName

Methods

toHeader :: HeaderName -> MetricsName -> [Header]

ToQuery MetricsName

Methods

toQuery :: MetricsName -> QueryString

ToByteString MetricsName

Methods

toBS :: MetricsName -> ByteString

FromText MetricsName

Methods

parser :: Parser MetricsName

ToText MetricsName

Methods

toText :: MetricsName -> Text

type Rep MetricsName

type Rep MetricsName = D1 * (MetaData "MetricsName" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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

Methods

minBound :: ScalingType

maxBound :: ScalingType

Enum ScalingType

Methods

succ :: ScalingType -> ScalingType

pred :: ScalingType -> ScalingType

toEnum :: Int -> ScalingType

fromEnum :: ScalingType -> Int

enumFrom :: ScalingType -> [ScalingType]

enumFromThen :: ScalingType -> ScalingType -> [ScalingType]

enumFromTo :: ScalingType -> ScalingType -> [ScalingType]

enumFromThenTo :: ScalingType -> ScalingType -> ScalingType -> [ScalingType]

Eq ScalingType

Methods

(==) :: ScalingType -> ScalingType -> Bool

(/=) :: ScalingType -> ScalingType -> Bool

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

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

Methods

readsPrec :: Int -> ReadS ScalingType

readList :: ReadS [ScalingType]

readPrec :: ReadPrec ScalingType

readListPrec :: ReadPrec [ScalingType]

Show ScalingType

Methods

showsPrec :: Int -> ScalingType -> ShowS

show :: ScalingType -> String

showList :: [ScalingType] -> ShowS

Generic ScalingType

Associated Types

type Rep ScalingType :: * -> *

Methods

from :: ScalingType -> Rep ScalingType x

to :: Rep ScalingType x -> ScalingType

Hashable ScalingType

Methods

hashWithSalt :: Int -> ScalingType -> Int

hash :: ScalingType -> Int

ToJSON ScalingType

Methods

toJSON :: ScalingType -> Value

toEncoding :: ScalingType -> Encoding

toJSONList :: [ScalingType] -> Value

toEncodingList :: [ScalingType] -> Encoding

NFData ScalingType

Methods

rnf :: ScalingType -> ()

ToHeader ScalingType

Methods

toHeader :: HeaderName -> ScalingType -> [Header]

ToQuery ScalingType

Methods

toQuery :: ScalingType -> QueryString

ToByteString ScalingType

Methods

toBS :: ScalingType -> ByteString

FromText ScalingType

Methods

parser :: Parser ScalingType

ToText ScalingType

Methods

toText :: ScalingType -> Text

type Rep ScalingType

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

ShardIteratorType

data ShardIteratorType

Constructors

AfterSequenceNumber

AtSequenceNumber

AtTimestamp

Latest

TrimHorizon

Instances

Bounded ShardIteratorType

Methods

minBound :: ShardIteratorType

maxBound :: ShardIteratorType

Enum ShardIteratorType

Methods

succ :: ShardIteratorType -> ShardIteratorType

pred :: ShardIteratorType -> ShardIteratorType

toEnum :: Int -> ShardIteratorType

fromEnum :: ShardIteratorType -> Int

enumFrom :: ShardIteratorType -> [ShardIteratorType]

enumFromThen :: ShardIteratorType -> ShardIteratorType -> [ShardIteratorType]

enumFromTo :: ShardIteratorType -> ShardIteratorType -> [ShardIteratorType]

enumFromThenTo :: ShardIteratorType -> ShardIteratorType -> ShardIteratorType -> [ShardIteratorType]

Eq ShardIteratorType

Methods

(==) :: ShardIteratorType -> ShardIteratorType -> Bool

(/=) :: ShardIteratorType -> ShardIteratorType -> Bool

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

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

Methods

readsPrec :: Int -> ReadS ShardIteratorType

readList :: ReadS [ShardIteratorType]

readPrec :: ReadPrec ShardIteratorType

readListPrec :: ReadPrec [ShardIteratorType]

Show ShardIteratorType

Methods

showsPrec :: Int -> ShardIteratorType -> ShowS

show :: ShardIteratorType -> String

showList :: [ShardIteratorType] -> ShowS

Generic ShardIteratorType

Associated Types

type Rep ShardIteratorType :: * -> *

Methods

from :: ShardIteratorType -> Rep ShardIteratorType x

to :: Rep ShardIteratorType x -> ShardIteratorType

Hashable ShardIteratorType

Methods

hashWithSalt :: Int -> ShardIteratorType -> Int

hash :: ShardIteratorType -> Int

ToJSON ShardIteratorType

Methods

toJSON :: ShardIteratorType -> Value

toEncoding :: ShardIteratorType -> Encoding

toJSONList :: [ShardIteratorType] -> Value

toEncodingList :: [ShardIteratorType] -> Encoding

NFData ShardIteratorType

Methods

rnf :: ShardIteratorType -> ()

ToHeader ShardIteratorType

Methods

toHeader :: HeaderName -> ShardIteratorType -> [Header]

ToQuery ShardIteratorType

Methods

toQuery :: ShardIteratorType -> QueryString

ToByteString ShardIteratorType

Methods

toBS :: ShardIteratorType -> ByteString

FromText ShardIteratorType

Methods

parser :: Parser ShardIteratorType

ToText ShardIteratorType

Methods

toText :: ShardIteratorType -> Text

type Rep ShardIteratorType

type Rep ShardIteratorType = D1 * (MetaData "ShardIteratorType" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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

Methods

minBound :: StreamStatus

maxBound :: StreamStatus

Enum StreamStatus

Methods

succ :: StreamStatus -> StreamStatus

pred :: StreamStatus -> StreamStatus

toEnum :: Int -> StreamStatus

fromEnum :: StreamStatus -> Int

enumFrom :: StreamStatus -> [StreamStatus]

enumFromThen :: StreamStatus -> StreamStatus -> [StreamStatus]

enumFromTo :: StreamStatus -> StreamStatus -> [StreamStatus]

enumFromThenTo :: StreamStatus -> StreamStatus -> StreamStatus -> [StreamStatus]

Eq StreamStatus

Methods

(==) :: StreamStatus -> StreamStatus -> Bool

(/=) :: StreamStatus -> StreamStatus -> Bool

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

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

Methods

readsPrec :: Int -> ReadS StreamStatus

readList :: ReadS [StreamStatus]

readPrec :: ReadPrec StreamStatus

readListPrec :: ReadPrec [StreamStatus]

Show StreamStatus

Methods

showsPrec :: Int -> StreamStatus -> ShowS

show :: StreamStatus -> String

showList :: [StreamStatus] -> ShowS

Generic StreamStatus

Associated Types

type Rep StreamStatus :: * -> *

Methods

from :: StreamStatus -> Rep StreamStatus x

to :: Rep StreamStatus x -> StreamStatus

Hashable StreamStatus

Methods

hashWithSalt :: Int -> StreamStatus -> Int

hash :: StreamStatus -> Int

FromJSON StreamStatus

Methods

parseJSON :: Value -> Parser StreamStatus

parseJSONList :: Value -> Parser [StreamStatus]

NFData StreamStatus

Methods

rnf :: StreamStatus -> ()

ToHeader StreamStatus

Methods

toHeader :: HeaderName -> StreamStatus -> [Header]

ToQuery StreamStatus

Methods

toQuery :: StreamStatus -> QueryString

ToByteString StreamStatus

Methods

toBS :: StreamStatus -> ByteString

FromText StreamStatus

Methods

parser :: Parser StreamStatus

ToText StreamStatus

Methods

toText :: StreamStatus -> Text

type Rep StreamStatus

type Rep StreamStatus = D1 * (MetaData "StreamStatus" "Network.AWS.Kinesis.Types.Sum" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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

Methods

(==) :: EnhancedMetrics -> EnhancedMetrics -> Bool

(/=) :: EnhancedMetrics -> EnhancedMetrics -> Bool

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

Methods

readsPrec :: Int -> ReadS EnhancedMetrics

readList :: ReadS [EnhancedMetrics]

readPrec :: ReadPrec EnhancedMetrics

readListPrec :: ReadPrec [EnhancedMetrics]

Show EnhancedMetrics

Methods

showsPrec :: Int -> EnhancedMetrics -> ShowS

show :: EnhancedMetrics -> String

showList :: [EnhancedMetrics] -> ShowS

Generic EnhancedMetrics

Associated Types

type Rep EnhancedMetrics :: * -> *

Methods

from :: EnhancedMetrics -> Rep EnhancedMetrics x

to :: Rep EnhancedMetrics x -> EnhancedMetrics

Hashable EnhancedMetrics

Methods

hashWithSalt :: Int -> EnhancedMetrics -> Int

hash :: EnhancedMetrics -> Int

FromJSON EnhancedMetrics

Methods

parseJSON :: Value -> Parser EnhancedMetrics

parseJSONList :: Value -> Parser [EnhancedMetrics]

NFData EnhancedMetrics

Methods

rnf :: EnhancedMetrics -> ()

type Rep EnhancedMetrics

type Rep EnhancedMetrics = D1 * (MetaData "EnhancedMetrics" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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 Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide .

emShardLevelMetrics :: Lens' EnhancedMetrics [MetricsName]

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

EnhancedMonitoringOutput

data EnhancedMonitoringOutput

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring .

See: enhancedMonitoringOutput smart constructor.

Instances

Eq EnhancedMonitoringOutput

Methods

(==) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool

(/=) :: EnhancedMonitoringOutput -> EnhancedMonitoringOutput -> Bool

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

Methods

readsPrec :: Int -> ReadS EnhancedMonitoringOutput

readList :: ReadS [EnhancedMonitoringOutput]

readPrec :: ReadPrec EnhancedMonitoringOutput

readListPrec :: ReadPrec [EnhancedMonitoringOutput]

Show EnhancedMonitoringOutput

Methods

showsPrec :: Int -> EnhancedMonitoringOutput -> ShowS

show :: EnhancedMonitoringOutput -> String

showList :: [EnhancedMonitoringOutput] -> ShowS

Generic EnhancedMonitoringOutput

Associated Types

type Rep EnhancedMonitoringOutput :: * -> *

Methods

from :: EnhancedMonitoringOutput -> Rep EnhancedMonitoringOutput x

to :: Rep EnhancedMonitoringOutput x -> EnhancedMonitoringOutput

Hashable EnhancedMonitoringOutput

Methods

hashWithSalt :: Int -> EnhancedMonitoringOutput -> Int

hash :: EnhancedMonitoringOutput -> Int

FromJSON EnhancedMonitoringOutput

Methods

parseJSON :: Value -> Parser EnhancedMonitoringOutput

parseJSONList :: Value -> Parser [EnhancedMonitoringOutput]

NFData EnhancedMonitoringOutput

Methods

rnf :: EnhancedMonitoringOutput -> ()

type Rep EnhancedMonitoringOutput

type Rep EnhancedMonitoringOutput = D1 * (MetaData "EnhancedMonitoringOutput" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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 - Represents the list of all the metrics that would be in the enhanced state after the operation.
• emoCurrentShardLevelMetrics - Represents the current state of the metrics that are in the enhanced state before the operation.
• emoStreamName - The name of the Kinesis data stream.

emoDesiredShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

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

emoCurrentShardLevelMetrics :: Lens' EnhancedMonitoringOutput [MetricsName]

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

emoStreamName :: Lens' EnhancedMonitoringOutput (Maybe Text)

The name of the Kinesis data stream.

HashKeyRange

data HashKeyRange

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

See: hashKeyRange smart constructor.

Instances

Eq HashKeyRange

Methods

(==) :: HashKeyRange -> HashKeyRange -> Bool

(/=) :: HashKeyRange -> HashKeyRange -> Bool

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

Methods

readsPrec :: Int -> ReadS HashKeyRange

readList :: ReadS [HashKeyRange]

readPrec :: ReadPrec HashKeyRange

readListPrec :: ReadPrec [HashKeyRange]

Show HashKeyRange

Methods

showsPrec :: Int -> HashKeyRange -> ShowS

show :: HashKeyRange -> String

showList :: [HashKeyRange] -> ShowS

Generic HashKeyRange

Associated Types

type Rep HashKeyRange :: * -> *

Methods

from :: HashKeyRange -> Rep HashKeyRange x

to :: Rep HashKeyRange x -> HashKeyRange

Hashable HashKeyRange

Methods

hashWithSalt :: Int -> HashKeyRange -> Int

hash :: HashKeyRange -> Int

FromJSON HashKeyRange

Methods

parseJSON :: Value -> Parser HashKeyRange

parseJSONList :: Value -> Parser [HashKeyRange]

NFData HashKeyRange

Methods

rnf :: HashKeyRange -> ()

type Rep HashKeyRange

type Rep HashKeyRange = D1 * (MetaData "HashKeyRange" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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

Arguments

:: Text

hkrStartingHashKey

-> Text

hkrEndingHashKey

-> HashKeyRange

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

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

• hkrStartingHashKey - The starting hash key of the hash key range.
• hkrEndingHashKey - The ending hash key of the hash key range.

hkrStartingHashKey :: Lens' HashKeyRange Text

The starting hash key of the hash key range.

hkrEndingHashKey :: Lens' HashKeyRange Text

The ending hash key of the hash key range.

PutRecordsRequestEntry

data PutRecordsRequestEntry

Represents the output for PutRecords .

See: putRecordsRequestEntry smart constructor.

Instances

Eq PutRecordsRequestEntry

Methods

(==) :: PutRecordsRequestEntry -> PutRecordsRequestEntry -> Bool

(/=) :: PutRecordsRequestEntry -> PutRecordsRequestEntry -> Bool

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

Methods

readsPrec :: Int -> ReadS PutRecordsRequestEntry

readList :: ReadS [PutRecordsRequestEntry]

readPrec :: ReadPrec PutRecordsRequestEntry

readListPrec :: ReadPrec [PutRecordsRequestEntry]

Show PutRecordsRequestEntry

Methods

showsPrec :: Int -> PutRecordsRequestEntry -> ShowS

show :: PutRecordsRequestEntry -> String

showList :: [PutRecordsRequestEntry] -> ShowS

Generic PutRecordsRequestEntry

Associated Types

type Rep PutRecordsRequestEntry :: * -> *

Methods

from :: PutRecordsRequestEntry -> Rep PutRecordsRequestEntry x

to :: Rep PutRecordsRequestEntry x -> PutRecordsRequestEntry

Hashable PutRecordsRequestEntry

Methods

hashWithSalt :: Int -> PutRecordsRequestEntry -> Int

hash :: PutRecordsRequestEntry -> Int

ToJSON PutRecordsRequestEntry

Methods

toJSON :: PutRecordsRequestEntry -> Value

toEncoding :: PutRecordsRequestEntry -> Encoding

toJSONList :: [PutRecordsRequestEntry] -> Value

toEncodingList :: [PutRecordsRequestEntry] -> Encoding

NFData PutRecordsRequestEntry

Methods

rnf :: PutRecordsRequestEntry -> ()

type Rep PutRecordsRequestEntry

type Rep PutRecordsRequestEntry = D1 * (MetaData "PutRecordsRequestEntry" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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

Arguments

:: ByteString

prreData

-> Text

prrePartitionKey

-> 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 Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

prreExplicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)

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

prreData :: Lens' PutRecordsRequestEntry ByteString

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

prrePartitionKey :: Lens' PutRecordsRequestEntry Text

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

PutRecordsResultEntry

data PutRecordsResultEntry

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

See: putRecordsResultEntry smart constructor.

Instances

Eq PutRecordsResultEntry

Methods

(==) :: PutRecordsResultEntry -> PutRecordsResultEntry -> Bool

(/=) :: PutRecordsResultEntry -> PutRecordsResultEntry -> Bool

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

Methods

readsPrec :: Int -> ReadS PutRecordsResultEntry

readList :: ReadS [PutRecordsResultEntry]

readPrec :: ReadPrec PutRecordsResultEntry

readListPrec :: ReadPrec [PutRecordsResultEntry]

Show PutRecordsResultEntry

Methods

showsPrec :: Int -> PutRecordsResultEntry -> ShowS

show :: PutRecordsResultEntry -> String

showList :: [PutRecordsResultEntry] -> ShowS

Generic PutRecordsResultEntry

Associated Types

type Rep PutRecordsResultEntry :: * -> *

Methods

from :: PutRecordsResultEntry -> Rep PutRecordsResultEntry x

to :: Rep PutRecordsResultEntry x -> PutRecordsResultEntry

Hashable PutRecordsResultEntry

Methods

hashWithSalt :: Int -> PutRecordsResultEntry -> Int

hash :: PutRecordsResultEntry -> Int

FromJSON PutRecordsResultEntry

Methods

parseJSON :: Value -> Parser PutRecordsResultEntry

parseJSONList :: Value -> Parser [PutRecordsResultEntry]

NFData PutRecordsResultEntry

Methods

rnf :: PutRecordsResultEntry -> ()

type Rep PutRecordsResultEntry

type Rep PutRecordsResultEntry = D1 * (MetaData "PutRecordsResultEntry" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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 Kinesis data 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

Methods

readsPrec :: Int -> ReadS Record

readList :: ReadS [Record]

readPrec :: ReadPrec Record

readListPrec :: ReadPrec [Record]

Show Record

Methods

showsPrec :: Int -> Record -> ShowS

show :: Record -> String

showList :: [Record] -> ShowS

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

Methods

parseJSON :: Value -> Parser Record

parseJSONList :: Value -> Parser [Record]

NFData Record

Methods

rnf :: Record -> ()

type Rep Record

type Rep Record = D1 * (MetaData "Record" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "Record'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rEncryptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EncryptionType))) (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

Arguments

:: Text

rSequenceNumber

-> ByteString

rData

-> Text

rPartitionKey

-> Record

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

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

• rEncryptionType - The encryption type used on the record. This parameter can be one of the following values: * NONE : Do not encrypt the records in the stream. * KMS : Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.
• rApproximateArrivalTimestamp - The approximate time that the record was inserted into the stream.
• rSequenceNumber - The unique identifier of the record within its shard.
• rData - The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- Note: 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.

rEncryptionType :: Lens' Record (Maybe EncryptionType)

The encryption type used on the record. This parameter can be one of the following values: * NONE : Do not encrypt the records in the stream. * KMS : Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

rApproximateArrivalTimestamp :: Lens' Record (Maybe UTCTime)

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

rSequenceNumber :: Lens' Record Text

The unique identifier of the record within its shard.

rData :: Lens' Record ByteString

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

rPartitionKey :: Lens' Record Text

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

SequenceNumberRange

data SequenceNumberRange

The range of possible sequence numbers for the shard.

See: sequenceNumberRange smart constructor.

Instances

Eq SequenceNumberRange

Methods

(==) :: SequenceNumberRange -> SequenceNumberRange -> Bool

(/=) :: SequenceNumberRange -> SequenceNumberRange -> Bool

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

Methods

readsPrec :: Int -> ReadS SequenceNumberRange

readList :: ReadS [SequenceNumberRange]

readPrec :: ReadPrec SequenceNumberRange

readListPrec :: ReadPrec [SequenceNumberRange]

Show SequenceNumberRange

Methods

showsPrec :: Int -> SequenceNumberRange -> ShowS

show :: SequenceNumberRange -> String

showList :: [SequenceNumberRange] -> ShowS

Generic SequenceNumberRange

Associated Types

type Rep SequenceNumberRange :: * -> *

Methods

from :: SequenceNumberRange -> Rep SequenceNumberRange x

to :: Rep SequenceNumberRange x -> SequenceNumberRange

Hashable SequenceNumberRange

Methods

hashWithSalt :: Int -> SequenceNumberRange -> Int

hash :: SequenceNumberRange -> Int

FromJSON SequenceNumberRange

Methods

parseJSON :: Value -> Parser SequenceNumberRange

parseJSONList :: Value -> Parser [SequenceNumberRange]

NFData SequenceNumberRange

Methods

rnf :: SequenceNumberRange -> ()

type Rep SequenceNumberRange

type Rep SequenceNumberRange = D1 * (MetaData "SequenceNumberRange" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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

Arguments

:: Text

snrStartingSequenceNumber

-> SequenceNumberRange

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

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

• snrEndingSequenceNumber - The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null .
• snrStartingSequenceNumber - The starting sequence number for the range.

snrEndingSequenceNumber :: Lens' SequenceNumberRange (Maybe Text)

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

snrStartingSequenceNumber :: Lens' SequenceNumberRange Text

The starting sequence number for the range.

Shard

data Shard

A uniquely identified group of data records in a Kinesis data 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

Methods

readsPrec :: Int -> ReadS Shard

readList :: ReadS [Shard]

readPrec :: ReadPrec Shard

readListPrec :: ReadPrec [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

Methods

parseJSON :: Value -> Parser Shard

parseJSONList :: Value -> Parser [Shard]

NFData Shard

Methods

rnf :: Shard -> ()

type Rep Shard

type Rep Shard = D1 * (MetaData "Shard" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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

Arguments

:: Text

sShardId

-> HashKeyRange

sHashKeyRange

-> SequenceNumberRange

sSequenceNumberRange

-> 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

Methods

(==) :: StreamDescription -> StreamDescription -> Bool

(/=) :: StreamDescription -> StreamDescription -> Bool

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

Methods

readsPrec :: Int -> ReadS StreamDescription

readList :: ReadS [StreamDescription]

readPrec :: ReadPrec StreamDescription

readListPrec :: ReadPrec [StreamDescription]

Show StreamDescription

Methods

showsPrec :: Int -> StreamDescription -> ShowS

show :: StreamDescription -> String

showList :: [StreamDescription] -> ShowS

Generic StreamDescription

Associated Types

type Rep StreamDescription :: * -> *

Methods

from :: StreamDescription -> Rep StreamDescription x

to :: Rep StreamDescription x -> StreamDescription

Hashable StreamDescription

Methods

hashWithSalt :: Int -> StreamDescription -> Int

hash :: StreamDescription -> Int

FromJSON StreamDescription

Methods

parseJSON :: Value -> Parser StreamDescription

parseJSONList :: Value -> Parser [StreamDescription]

NFData StreamDescription

Methods

rnf :: StreamDescription -> ()

type Rep StreamDescription

type Rep StreamDescription = D1 * (MetaData "StreamDescription" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "StreamDescription'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sdEncryptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EncryptionType))) (S1 * (MetaSel (Just Symbol "_sdKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (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 DecidedStrict) (Rec0 * POSIX)) (S1 * (MetaSel (Just Symbol "_sdEnhancedMonitoring") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [EnhancedMetrics])))))))

streamDescription

Arguments

:: Text

sdStreamName

-> Text

sdStreamARN

-> StreamStatus

sdStreamStatus

-> Bool

sdHasMoreShards

-> Natural

sdRetentionPeriodHours

-> UTCTime

sdStreamCreationTimestamp

-> StreamDescription

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

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

• sdEncryptionType - The server-side encryption type used on the stream. This parameter can be one of the following values: * NONE : Do not encrypt the records in the stream. * KMS : Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.
• sdKeyId - The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias".You can also use a master key owned by Kinesis Data Streams by specifying the alias @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@
• sdStreamName - The name of the stream being described.
• sdStreamARN - The Amazon Resource Name (ARN) for the stream being described.
• sdStreamStatus - The current status of the stream being described. The stream status is one of the following states: * CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING . * DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. * ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream. * UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
• sdShards - 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.

sdEncryptionType :: Lens' StreamDescription (Maybe EncryptionType)

The server-side encryption type used on the stream. This parameter can be one of the following values: * NONE : Do not encrypt the records in the stream. * KMS : Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

sdKeyId :: Lens' StreamDescription (Maybe Text)

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias".You can also use a master key owned by Kinesis Data Streams by specifying the alias @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@

sdStreamName :: Lens' StreamDescription Text

The name of the stream being described.

sdStreamARN :: Lens' StreamDescription Text

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

sdStreamStatus :: Lens' StreamDescription StreamStatus

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

sdShards :: Lens' StreamDescription [Shard]

The shards that comprise the stream.

sdHasMoreShards :: Lens' StreamDescription Bool

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

sdRetentionPeriodHours :: Lens' StreamDescription Natural

The current retention period, in hours.

sdStreamCreationTimestamp :: Lens' StreamDescription UTCTime

The approximate time that the stream was created.

sdEnhancedMonitoring :: Lens' StreamDescription [EnhancedMetrics]

Represents the current enhanced monitoring settings of the stream.

StreamDescriptionSummary

data StreamDescriptionSummary

Represents the output for DescribeStreamSummary

See: streamDescriptionSummary smart constructor.

Instances

Eq StreamDescriptionSummary

Methods

(==) :: StreamDescriptionSummary -> StreamDescriptionSummary -> Bool

(/=) :: StreamDescriptionSummary -> StreamDescriptionSummary -> Bool

Data StreamDescriptionSummary

Methods

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

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

toConstr :: StreamDescriptionSummary -> Constr

dataTypeOf :: StreamDescriptionSummary -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> StreamDescriptionSummary -> StreamDescriptionSummary

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

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

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

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

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

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

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

Read StreamDescriptionSummary

Methods

readsPrec :: Int -> ReadS StreamDescriptionSummary

readList :: ReadS [StreamDescriptionSummary]

readPrec :: ReadPrec StreamDescriptionSummary

readListPrec :: ReadPrec [StreamDescriptionSummary]

Show StreamDescriptionSummary

Methods

showsPrec :: Int -> StreamDescriptionSummary -> ShowS

show :: StreamDescriptionSummary -> String

showList :: [StreamDescriptionSummary] -> ShowS

Generic StreamDescriptionSummary

Associated Types

type Rep StreamDescriptionSummary :: * -> *

Methods

from :: StreamDescriptionSummary -> Rep StreamDescriptionSummary x

to :: Rep StreamDescriptionSummary x -> StreamDescriptionSummary

Hashable StreamDescriptionSummary

Methods

hashWithSalt :: Int -> StreamDescriptionSummary -> Int

hash :: StreamDescriptionSummary -> Int

FromJSON StreamDescriptionSummary

Methods

parseJSON :: Value -> Parser StreamDescriptionSummary

parseJSONList :: Value -> Parser [StreamDescriptionSummary]

NFData StreamDescriptionSummary

Methods

rnf :: StreamDescriptionSummary -> ()

type Rep StreamDescriptionSummary

type Rep StreamDescriptionSummary = D1 * (MetaData "StreamDescriptionSummary" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "StreamDescriptionSummary'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sdsEncryptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EncryptionType))) (S1 * (MetaSel (Just Symbol "_sdsKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdsStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sdsStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sdsStreamStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * StreamStatus)) (S1 * (MetaSel (Just Symbol "_sdsRetentionPeriodHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdsStreamCreationTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * POSIX)) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdsEnhancedMonitoring") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [EnhancedMetrics])) (S1 * (MetaSel (Just Symbol "_sdsOpenShardCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat)))))))

streamDescriptionSummary

Arguments

:: Text

sdsStreamName

-> Text

sdsStreamARN

-> StreamStatus

sdsStreamStatus

-> Natural

sdsRetentionPeriodHours

-> UTCTime

sdsStreamCreationTimestamp

-> Natural

sdsOpenShardCount

-> StreamDescriptionSummary

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

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

• sdsEncryptionType - The encryption type used. This value is one of the following: * KMS * NONE
• sdsKeyId - The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias".You can also use a master key owned by Kinesis Data Streams by specifying the alias @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@
• sdsStreamName - The name of the stream being described.
• sdsStreamARN - The Amazon Resource Name (ARN) for the stream being described.
• sdsStreamStatus - The current status of the stream being described. The stream status is one of the following states: * CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING . * DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. * ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream. * UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
• sdsRetentionPeriodHours - The current retention period, in hours.
• sdsStreamCreationTimestamp - The approximate time that the stream was created.
• sdsEnhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
• sdsOpenShardCount - The number of open shards in the stream.

sdsEncryptionType :: Lens' StreamDescriptionSummary (Maybe EncryptionType)

The encryption type used. This value is one of the following: * KMS * NONE

sdsKeyId :: Lens' StreamDescriptionSummary (Maybe Text)

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias".You can also use a master key owned by Kinesis Data Streams by specifying the alias @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@

sdsStreamName :: Lens' StreamDescriptionSummary Text

The name of the stream being described.

sdsStreamARN :: Lens' StreamDescriptionSummary Text

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

sdsStreamStatus :: Lens' StreamDescriptionSummary StreamStatus

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

sdsRetentionPeriodHours :: Lens' StreamDescriptionSummary Natural

The current retention period, in hours.

sdsStreamCreationTimestamp :: Lens' StreamDescriptionSummary UTCTime

The approximate time that the stream was created.

sdsEnhancedMonitoring :: Lens' StreamDescriptionSummary [EnhancedMetrics]

Represents the current enhanced monitoring settings of the stream.

sdsOpenShardCount :: Lens' StreamDescriptionSummary Natural

The number of open shards in the stream.

Tag

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

Methods

readsPrec :: Int -> ReadS Tag

readList :: ReadS [Tag]

readPrec :: ReadPrec Tag

readListPrec :: ReadPrec [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

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

NFData Tag

Methods

rnf :: Tag -> ()

type Rep Tag

type Rep Tag = D1 * (MetaData "Tag" "Network.AWS.Kinesis.Types.Product" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" 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, _ . / = + - % @