amazonka-kinesis-video-1.6.0: Amazon Kinesis Video Streams 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.KinesisVideo

Contents

Description

 

Synopsis

Service Configuration

kinesisVideo :: Service Source #

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

InvalidArgumentException

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

The value for this input parameter is invalid.

TagsPerResourceExceededLimitException

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

You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.

NotAuthorizedException

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

The caller is not authorized to perform this operation.

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.

InvalidDeviceException

VersionMismatchException

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

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

AccountStreamLimitExceededException

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

The number of streams created for the account is too high.

InvalidResourceFormatException

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

The format of the StreamARN is invalid.

DeviceStreamLimitExceededException

ResourceNotFoundException

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

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

ResourceInUseException

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

The stream is currently not available for this operation.

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.

UntagStream

UpdateDataRetention

GetDataEndpoint

ListTagsForStream

UpdateStream

DeleteStream

ListStreams

CreateStream

TagStream

DescribeStream

Types

APIName

data APIName Source #

Instances

Bounded APIName Source # 
Enum APIName Source # 
Eq APIName Source # 

Methods

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

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

Data APIName Source # 

Methods

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

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

toConstr :: APIName -> Constr #

dataTypeOf :: APIName -> DataType #

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

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

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

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

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

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

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

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

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

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

Ord APIName Source # 
Read APIName Source # 
Show APIName Source # 
Generic APIName Source # 

Associated Types

type Rep APIName :: * -> * #

Methods

from :: APIName -> Rep APIName x #

to :: Rep APIName x -> APIName #

Hashable APIName Source # 

Methods

hashWithSalt :: Int -> APIName -> Int #

hash :: APIName -> Int #

ToJSON APIName Source # 
NFData APIName Source # 

Methods

rnf :: APIName -> () #

ToHeader APIName Source # 

Methods

toHeader :: HeaderName -> APIName -> [Header] #

ToQuery APIName Source # 
ToByteString APIName Source # 

Methods

toBS :: APIName -> ByteString #

FromText APIName Source # 
ToText APIName Source # 

Methods

toText :: APIName -> Text #

type Rep APIName Source # 
type Rep APIName = D1 * (MetaData "APIName" "Network.AWS.KinesisVideo.Types.Sum" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) ((:+:) * ((:+:) * (C1 * (MetaCons "GetMedia" PrefixI False) (U1 *)) (C1 * (MetaCons "GetMediaForFragmentList" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "ListFragments" PrefixI False) (U1 *)) (C1 * (MetaCons "PutMedia" PrefixI False) (U1 *))))

ComparisonOperator

data ComparisonOperator Source #

Constructors

BeginsWith 

Instances

Bounded ComparisonOperator Source # 
Enum ComparisonOperator Source # 
Eq ComparisonOperator Source # 
Data ComparisonOperator Source # 

Methods

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

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

toConstr :: ComparisonOperator -> Constr #

dataTypeOf :: ComparisonOperator -> DataType #

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

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

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

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

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

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

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

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

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

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

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

Methods

rnf :: ComparisonOperator -> () #

ToHeader ComparisonOperator Source # 
ToQuery ComparisonOperator Source # 
ToByteString ComparisonOperator Source # 
FromText ComparisonOperator Source # 
ToText ComparisonOperator Source # 
type Rep ComparisonOperator Source # 
type Rep ComparisonOperator = D1 * (MetaData "ComparisonOperator" "Network.AWS.KinesisVideo.Types.Sum" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "BeginsWith" PrefixI False) (U1 *))

StreamStatus

data StreamStatus Source #

Constructors

Active 
Creating 
Deleting 
Updating 

Instances

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

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 Source # 
Read StreamStatus Source # 
Show StreamStatus Source # 
Generic StreamStatus Source # 

Associated Types

type Rep StreamStatus :: * -> * #

Hashable StreamStatus Source # 
FromJSON StreamStatus Source # 
NFData StreamStatus Source # 

Methods

rnf :: StreamStatus -> () #

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

Methods

toText :: StreamStatus -> Text #

type Rep StreamStatus Source # 
type Rep StreamStatus = D1 * (MetaData "StreamStatus" "Network.AWS.KinesisVideo.Types.Sum" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" 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 *))))

UpdateDataRetentionOperation

data UpdateDataRetentionOperation Source #

Instances

Bounded UpdateDataRetentionOperation Source # 
Enum UpdateDataRetentionOperation Source # 
Eq UpdateDataRetentionOperation Source # 
Data UpdateDataRetentionOperation Source # 

Methods

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

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

toConstr :: UpdateDataRetentionOperation -> Constr #

dataTypeOf :: UpdateDataRetentionOperation -> DataType #

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

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

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

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

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

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

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

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

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

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

Ord UpdateDataRetentionOperation Source # 
Read UpdateDataRetentionOperation Source # 
Show UpdateDataRetentionOperation Source # 
Generic UpdateDataRetentionOperation Source # 
Hashable UpdateDataRetentionOperation Source # 
ToJSON UpdateDataRetentionOperation Source # 
NFData UpdateDataRetentionOperation Source # 
ToHeader UpdateDataRetentionOperation Source # 
ToQuery UpdateDataRetentionOperation Source # 
ToByteString UpdateDataRetentionOperation Source # 
FromText UpdateDataRetentionOperation Source # 
ToText UpdateDataRetentionOperation Source # 
type Rep UpdateDataRetentionOperation Source # 
type Rep UpdateDataRetentionOperation = D1 * (MetaData "UpdateDataRetentionOperation" "Network.AWS.KinesisVideo.Types.Sum" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) ((:+:) * (C1 * (MetaCons "DecreaseDataRetention" PrefixI False) (U1 *)) (C1 * (MetaCons "IncreaseDataRetention" PrefixI False) (U1 *)))

StreamInfo

data StreamInfo Source #

An object describing a Kinesis video stream.

See: streamInfo smart constructor.

Instances

Eq StreamInfo Source # 
Data StreamInfo Source # 

Methods

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

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

toConstr :: StreamInfo -> Constr #

dataTypeOf :: StreamInfo -> DataType #

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

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

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

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

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

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

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

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

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

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

Read StreamInfo Source # 
Show StreamInfo Source # 
Generic StreamInfo Source # 

Associated Types

type Rep StreamInfo :: * -> * #

Hashable StreamInfo Source # 
FromJSON StreamInfo Source # 
NFData StreamInfo Source # 

Methods

rnf :: StreamInfo -> () #

type Rep StreamInfo Source # 

streamInfo :: StreamInfo Source #

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

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

  • siCreationTime - A time stamp that indicates when the stream was created.
  • siStatus - The status of the stream.
  • siMediaType - The MediaType of the stream.
  • siDataRetentionInHours - How long the stream retains data, in hours.
  • siStreamARN - The Amazon Resource Name (ARN) of the stream.
  • siKMSKeyId - The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.
  • siDeviceName - The name of the device that is associated with the stream.
  • siVersion - The version of the stream.
  • siStreamName - The name of the stream.

siCreationTime :: Lens' StreamInfo (Maybe UTCTime) Source #

A time stamp that indicates when the stream was created.

siStatus :: Lens' StreamInfo (Maybe StreamStatus) Source #

The status of the stream.

siMediaType :: Lens' StreamInfo (Maybe Text) Source #

The MediaType of the stream.

siDataRetentionInHours :: Lens' StreamInfo (Maybe Natural) Source #

How long the stream retains data, in hours.

siStreamARN :: Lens' StreamInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stream.

siKMSKeyId :: Lens' StreamInfo (Maybe Text) Source #

The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

siDeviceName :: Lens' StreamInfo (Maybe Text) Source #

The name of the device that is associated with the stream.

siVersion :: Lens' StreamInfo (Maybe Text) Source #

The version of the stream.

siStreamName :: Lens' StreamInfo (Maybe Text) Source #

The name of the stream.

StreamNameCondition

data StreamNameCondition Source #

Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

See: streamNameCondition smart constructor.

Instances

Eq StreamNameCondition Source # 
Data StreamNameCondition Source # 

Methods

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

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

toConstr :: StreamNameCondition -> Constr #

dataTypeOf :: StreamNameCondition -> DataType #

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

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

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

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

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

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

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

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

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

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

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

Methods

rnf :: StreamNameCondition -> () #

type Rep StreamNameCondition Source # 
type Rep StreamNameCondition = D1 * (MetaData "StreamNameCondition" "Network.AWS.KinesisVideo.Types.Product" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "StreamNameCondition'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sncComparisonOperator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ComparisonOperator))) (S1 * (MetaSel (Just Symbol "_sncComparisonValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

streamNameCondition :: StreamNameCondition Source #

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

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

  • sncComparisonOperator - A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.
  • sncComparisonValue - A value to compare.

sncComparisonOperator :: Lens' StreamNameCondition (Maybe ComparisonOperator) Source #

A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.