amazonka-kinesis-video-media-1.6.0: Amazon Kinesis Video Streams Media SDK.

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

Network.AWS.KinesisVideoMedia.Types

Contents

Description

 

Synopsis

Service Configuration

kinesisVideoMedia :: Service Source #

API version 2017-09-30 of the Amazon Kinesis Video Streams Media SDK configuration.

Errors

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

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.

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

The value for this input parameter is invalid.

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

Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

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

Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to READ and use the endpoint Kinesis Video returns in the next GetMedia call.

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

Status Code: 404, The stream with the given name does not exist.

StartSelectorType

data StartSelectorType Source #

Instances

Bounded StartSelectorType Source # 
Enum StartSelectorType Source # 
Eq StartSelectorType Source # 
Data StartSelectorType Source # 

Methods

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

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

toConstr :: StartSelectorType -> Constr #

dataTypeOf :: StartSelectorType -> DataType #

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

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

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

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

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

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

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

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

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

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

Ord StartSelectorType Source # 
Read StartSelectorType Source # 
Show StartSelectorType Source # 
Generic StartSelectorType Source # 
Hashable StartSelectorType Source # 
ToJSON StartSelectorType Source # 
NFData StartSelectorType Source # 

Methods

rnf :: StartSelectorType -> () #

ToHeader StartSelectorType Source # 
ToQuery StartSelectorType Source # 
ToByteString StartSelectorType Source # 
FromText StartSelectorType Source # 
ToText StartSelectorType Source # 
type Rep StartSelectorType Source # 
type Rep StartSelectorType = D1 * (MetaData "StartSelectorType" "Network.AWS.KinesisVideoMedia.Types.Sum" "amazonka-kinesis-video-media-1.6.0-5IbPEhFZvoxFr4q8Nts0ML" False) ((:+:) * ((:+:) * (C1 * (MetaCons "ContinuationToken" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "Earliest" PrefixI False) (U1 *)) (C1 * (MetaCons "FragmentNumber" PrefixI False) (U1 *)))) ((:+:) * (C1 * (MetaCons "Now" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "ProducerTimestamp" PrefixI False) (U1 *)) (C1 * (MetaCons "ServerTimestamp" PrefixI False) (U1 *)))))

StartSelector

data StartSelector Source #

Identifies the chunk on the Kinesis video stream where you want the GetMedia API to start returning media data. You have the following options to identify the starting chunk:

  • Choose the latest (or oldest) chunk.
  • Identify a specific chunk. You can identify a specific chunk either by providing a fragment number or time stamp (server or producer).
  • Each chunk's metadata includes a continuation token as a Matroska (MKV) tag (AWS_KINESISVIDEO_CONTINUATION_TOKEN ). If your previous GetMedia request terminated, you can use this tag value in your next GetMedia request. The API then starts returning chunks starting where the last API ended.

See: startSelector smart constructor.

Instances

Eq StartSelector Source # 
Data StartSelector Source # 

Methods

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

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

toConstr :: StartSelector -> Constr #

dataTypeOf :: StartSelector -> DataType #

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

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

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

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

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

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

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

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

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

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

Read StartSelector Source # 
Show StartSelector Source # 
Generic StartSelector Source # 

Associated Types

type Rep StartSelector :: * -> * #

Hashable StartSelector Source # 
ToJSON StartSelector Source # 
NFData StartSelector Source # 

Methods

rnf :: StartSelector -> () #

type Rep StartSelector Source # 
type Rep StartSelector = D1 * (MetaData "StartSelector" "Network.AWS.KinesisVideoMedia.Types.Product" "amazonka-kinesis-video-media-1.6.0-5IbPEhFZvoxFr4q8Nts0ML" False) (C1 * (MetaCons "StartSelector'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ssContinuationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ssAfterFragmentNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ssStartTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_ssStartSelectorType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * StartSelectorType)))))

startSelector Source #

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

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

  • ssContinuationToken - Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.
  • ssAfterFragmentNumber - Specifies the fragment number from where you want the GetMedia API to start returning the fragments.
  • ssStartTimestamp - A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType . The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.
  • ssStartSelectorType - Identifies the fragment on the Kinesis video stream where you want to start getting the data from. * NOW - Start with the latest chunk on the stream. * EARLIEST - Start with earliest available chunk on the stream. * FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber . * PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp . * CONTINUATION_TOKEN - Read using the specified continuation token.

ssContinuationToken :: Lens' StartSelector (Maybe Text) Source #

Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

ssAfterFragmentNumber :: Lens' StartSelector (Maybe Text) Source #

Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

ssStartTimestamp :: Lens' StartSelector (Maybe UTCTime) Source #

A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType . The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.

ssStartSelectorType :: Lens' StartSelector StartSelectorType Source #

Identifies the fragment on the Kinesis video stream where you want to start getting the data from. * NOW - Start with the latest chunk on the stream. * EARLIEST - Start with earliest available chunk on the stream. * FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber . * PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp . * CONTINUATION_TOKEN - Read using the specified continuation token.