Network.AWS.KinesisVideoMedia

Service Configuration

kinesisVideoMedia :: Service

API version 2017-09-30 of the Amazon Kinesis Video Streams Media 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 KinesisVideoMedia.

ConnectionLimitExceededException

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

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

InvalidArgumentException

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

The value for this input parameter is invalid.

NotAuthorizedException

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

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

ClientLimitExceededException

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

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

InvalidEndpointException

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

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

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

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

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.

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.

GetMedia

module Network.AWS.KinesisVideoMedia.GetMedia

Types

StartSelectorType

data StartSelectorType

Constructors

ContinuationToken

Earliest

FragmentNumber

Now

ProducerTimestamp

ServerTimestamp

Instances

Bounded StartSelectorType

Methods

minBound :: StartSelectorType

maxBound :: StartSelectorType

Enum StartSelectorType

Methods

succ :: StartSelectorType -> StartSelectorType

pred :: StartSelectorType -> StartSelectorType

toEnum :: Int -> StartSelectorType

fromEnum :: StartSelectorType -> Int

enumFrom :: StartSelectorType -> [StartSelectorType]

enumFromThen :: StartSelectorType -> StartSelectorType -> [StartSelectorType]

enumFromTo :: StartSelectorType -> StartSelectorType -> [StartSelectorType]

enumFromThenTo :: StartSelectorType -> StartSelectorType -> StartSelectorType -> [StartSelectorType]

Eq StartSelectorType

Methods

(==) :: StartSelectorType -> StartSelectorType -> Bool

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

Data StartSelectorType

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

Methods

compare :: StartSelectorType -> StartSelectorType -> Ordering

(<) :: StartSelectorType -> StartSelectorType -> Bool

(<=) :: StartSelectorType -> StartSelectorType -> Bool

(>) :: StartSelectorType -> StartSelectorType -> Bool

(>=) :: StartSelectorType -> StartSelectorType -> Bool

max :: StartSelectorType -> StartSelectorType -> StartSelectorType

min :: StartSelectorType -> StartSelectorType -> StartSelectorType

Read StartSelectorType

Methods

readsPrec :: Int -> ReadS StartSelectorType

readList :: ReadS [StartSelectorType]

readPrec :: ReadPrec StartSelectorType

readListPrec :: ReadPrec [StartSelectorType]

Show StartSelectorType

Methods

showsPrec :: Int -> StartSelectorType -> ShowS

show :: StartSelectorType -> String

showList :: [StartSelectorType] -> ShowS

Generic StartSelectorType

Associated Types

type Rep StartSelectorType :: * -> *

Methods

from :: StartSelectorType -> Rep StartSelectorType x

to :: Rep StartSelectorType x -> StartSelectorType

Hashable StartSelectorType

Methods

hashWithSalt :: Int -> StartSelectorType -> Int

hash :: StartSelectorType -> Int

ToJSON StartSelectorType

Methods

toJSON :: StartSelectorType -> Value

toEncoding :: StartSelectorType -> Encoding

toJSONList :: [StartSelectorType] -> Value

toEncodingList :: [StartSelectorType] -> Encoding

NFData StartSelectorType

Methods

rnf :: StartSelectorType -> ()

ToHeader StartSelectorType

Methods

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

ToQuery StartSelectorType

Methods

toQuery :: StartSelectorType -> QueryString

ToByteString StartSelectorType

Methods

toBS :: StartSelectorType -> ByteString

FromText StartSelectorType

Methods

parser :: Parser StartSelectorType

ToText StartSelectorType

Methods

toText :: StartSelectorType -> Text

type Rep StartSelectorType

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

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

Methods

(==) :: StartSelector -> StartSelector -> Bool

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

Data StartSelector

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

Methods

readsPrec :: Int -> ReadS StartSelector

readList :: ReadS [StartSelector]

readPrec :: ReadPrec StartSelector

readListPrec :: ReadPrec [StartSelector]

Show StartSelector

Methods

showsPrec :: Int -> StartSelector -> ShowS

show :: StartSelector -> String

showList :: [StartSelector] -> ShowS

Generic StartSelector

Associated Types

type Rep StartSelector :: * -> *

Methods

from :: StartSelector -> Rep StartSelector x

to :: Rep StartSelector x -> StartSelector

Hashable StartSelector

Methods

hashWithSalt :: Int -> StartSelector -> Int

hash :: StartSelector -> Int

ToJSON StartSelector

Methods

toJSON :: StartSelector -> Value

toEncoding :: StartSelector -> Encoding

toJSONList :: [StartSelector] -> Value

toEncodingList :: [StartSelector] -> Encoding

NFData StartSelector

Methods

rnf :: StartSelector -> ()

type Rep StartSelector

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

Arguments

:: StartSelectorType

ssStartSelectorType

-> StartSelector

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)

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)

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

ssStartTimestamp :: Lens' StartSelector (Maybe UTCTime)

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

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.