amazonka-kinesis-video-archived-media-1.6.0: Amazon Kinesis Video Streams Archived 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.KinesisVideoArchivedMedia

Contents

Description

 

Synopsis

Service Configuration

kinesisVideoArchivedMedia :: Service Source #

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

InvalidArgumentException

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

A specified parameter exceeds its restrictions, is not supported, or can't be used.

NotAuthorizedException

_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

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

ResourceNotFoundException

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

Kinesis Video Streams can't find the stream that you specified.

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.

GetMediaForFragmentList

ListFragments

Types

FragmentSelectorType

data FragmentSelectorType Source #

Instances

Bounded FragmentSelectorType Source # 
Enum FragmentSelectorType Source # 
Eq FragmentSelectorType Source # 
Data FragmentSelectorType Source # 

Methods

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

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

toConstr :: FragmentSelectorType -> Constr #

dataTypeOf :: FragmentSelectorType -> DataType #

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

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

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

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

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

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

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

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

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

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

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

Methods

rnf :: FragmentSelectorType -> () #

ToHeader FragmentSelectorType Source # 
ToQuery FragmentSelectorType Source # 
ToByteString FragmentSelectorType Source # 
FromText FragmentSelectorType Source # 
ToText FragmentSelectorType Source # 
type Rep FragmentSelectorType Source # 
type Rep FragmentSelectorType = D1 * (MetaData "FragmentSelectorType" "Network.AWS.KinesisVideoArchivedMedia.Types.Sum" "amazonka-kinesis-video-archived-media-1.6.0-BK4sg7YWMNVCwg3NegaW0Y" False) ((:+:) * (C1 * (MetaCons "ProducerTimestamp" PrefixI False) (U1 *)) (C1 * (MetaCons "ServerTimestamp" PrefixI False) (U1 *)))

Fragment

data Fragment Source #

Represents a segment of video or other time-delimited data.

See: fragment smart constructor.

Instances

Eq Fragment Source # 
Data Fragment Source # 

Methods

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

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

toConstr :: Fragment -> Constr #

dataTypeOf :: Fragment -> DataType #

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

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

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

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

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

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

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

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

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

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

Read Fragment Source # 
Show Fragment Source # 
Generic Fragment Source # 

Associated Types

type Rep Fragment :: * -> * #

Methods

from :: Fragment -> Rep Fragment x #

to :: Rep Fragment x -> Fragment #

Hashable Fragment Source # 

Methods

hashWithSalt :: Int -> Fragment -> Int #

hash :: Fragment -> Int #

FromJSON Fragment Source # 
NFData Fragment Source # 

Methods

rnf :: Fragment -> () #

type Rep Fragment Source # 
type Rep Fragment = D1 * (MetaData "Fragment" "Network.AWS.KinesisVideoArchivedMedia.Types.Product" "amazonka-kinesis-video-archived-media-1.6.0-BK4sg7YWMNVCwg3NegaW0Y" False) (C1 * (MetaCons "Fragment'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_fFragmentLengthInMilliseconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) (S1 * (MetaSel (Just Symbol "_fServerTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_fFragmentSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) ((:*:) * (S1 * (MetaSel (Just Symbol "_fFragmentNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_fProducerTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))))))

fragment :: Fragment Source #

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

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

fFragmentLengthInMilliseconds :: Lens' Fragment (Maybe Integer) Source #

The playback duration or other time value associated with the fragment.

fServerTimestamp :: Lens' Fragment (Maybe UTCTime) Source #

The time stamp from the AWS server corresponding to the fragment.

fFragmentSizeInBytes :: Lens' Fragment (Maybe Integer) Source #

The total fragment size, including information about the fragment and contained media data.

fFragmentNumber :: Lens' Fragment (Maybe Text) Source #

The index value of the fragment.

fProducerTimestamp :: Lens' Fragment (Maybe UTCTime) Source #

The time stamp from the producer corresponding to the fragment.

FragmentSelector

data FragmentSelector Source #

Describes the time stamp range and time stamp origin of a range of fragments.

See: fragmentSelector smart constructor.

Instances

Eq FragmentSelector Source # 
Data FragmentSelector Source # 

Methods

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

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

toConstr :: FragmentSelector -> Constr #

dataTypeOf :: FragmentSelector -> DataType #

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

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

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

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

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

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

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

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

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

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

Read FragmentSelector Source # 
Show FragmentSelector Source # 
Generic FragmentSelector Source # 
Hashable FragmentSelector Source # 
ToJSON FragmentSelector Source # 
NFData FragmentSelector Source # 

Methods

rnf :: FragmentSelector -> () #

type Rep FragmentSelector Source # 
type Rep FragmentSelector = D1 * (MetaData "FragmentSelector" "Network.AWS.KinesisVideoArchivedMedia.Types.Product" "amazonka-kinesis-video-archived-media-1.6.0-BK4sg7YWMNVCwg3NegaW0Y" False) (C1 * (MetaCons "FragmentSelector'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_fsFragmentSelectorType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * FragmentSelectorType)) (S1 * (MetaSel (Just Symbol "_fsTimestampRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * TimestampRange))))

fragmentSelector Source #

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

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

fsFragmentSelectorType :: Lens' FragmentSelector FragmentSelectorType Source #

The origin of the time stamps to use (Server or Producer).

fsTimestampRange :: Lens' FragmentSelector TimestampRange Source #

The range of time stamps to return.

TimestampRange

data TimestampRange Source #

The range of time stamps for which to return fragments.

See: timestampRange smart constructor.

Instances

Eq TimestampRange Source # 
Data TimestampRange Source # 

Methods

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

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

toConstr :: TimestampRange -> Constr #

dataTypeOf :: TimestampRange -> DataType #

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

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

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

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

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

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

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

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

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

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

Read TimestampRange Source # 
Show TimestampRange Source # 
Generic TimestampRange Source # 

Associated Types

type Rep TimestampRange :: * -> * #

Hashable TimestampRange Source # 
ToJSON TimestampRange Source # 
NFData TimestampRange Source # 

Methods

rnf :: TimestampRange -> () #

type Rep TimestampRange Source # 
type Rep TimestampRange = D1 * (MetaData "TimestampRange" "Network.AWS.KinesisVideoArchivedMedia.Types.Product" "amazonka-kinesis-video-archived-media-1.6.0-BK4sg7YWMNVCwg3NegaW0Y" False) (C1 * (MetaCons "TimestampRange'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_trStartTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * POSIX)) (S1 * (MetaSel (Just Symbol "_trEndTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * POSIX))))

timestampRange Source #

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

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

  • trStartTimestamp - The starting time stamp in the range of time stamps for which to return fragments.
  • trEndTimestamp - The ending time stamp in the range of time stamps for which to return fragments.

trStartTimestamp :: Lens' TimestampRange UTCTime Source #

The starting time stamp in the range of time stamps for which to return fragments.

trEndTimestamp :: Lens' TimestampRange UTCTime Source #

The ending time stamp in the range of time stamps for which to return fragments.