Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- InvalidArgumentException
- TagsPerResourceExceededLimitException
- NotAuthorizedException
- ClientLimitExceededException
- InvalidDeviceException
- VersionMismatchException
- AccountStreamLimitExceededException
- InvalidResourceFormatException
- DeviceStreamLimitExceededException
- ResourceNotFoundException
- ResourceInUseException
- Waiters
- Operations
- Types
- kinesisVideo :: Service
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagsPerResourceExceededLimitException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDeviceException :: AsError a => Getting (First ServiceError) a ServiceError
- _VersionMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountStreamLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidResourceFormatException :: AsError a => Getting (First ServiceError) a ServiceError
- _DeviceStreamLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.KinesisVideo.UntagStream
- module Network.AWS.KinesisVideo.UpdateDataRetention
- module Network.AWS.KinesisVideo.GetDataEndpoint
- module Network.AWS.KinesisVideo.ListTagsForStream
- module Network.AWS.KinesisVideo.UpdateStream
- module Network.AWS.KinesisVideo.DeleteStream
- module Network.AWS.KinesisVideo.ListStreams
- module Network.AWS.KinesisVideo.CreateStream
- module Network.AWS.KinesisVideo.TagStream
- module Network.AWS.KinesisVideo.DescribeStream
- data APIName
- data ComparisonOperator = BeginsWith
- data StreamStatus
- data UpdateDataRetentionOperation
- data StreamInfo
- streamInfo :: StreamInfo
- siCreationTime :: Lens' StreamInfo (Maybe UTCTime)
- siStatus :: Lens' StreamInfo (Maybe StreamStatus)
- siMediaType :: Lens' StreamInfo (Maybe Text)
- siDataRetentionInHours :: Lens' StreamInfo (Maybe Natural)
- siStreamARN :: Lens' StreamInfo (Maybe Text)
- siKMSKeyId :: Lens' StreamInfo (Maybe Text)
- siDeviceName :: Lens' StreamInfo (Maybe Text)
- siVersion :: Lens' StreamInfo (Maybe Text)
- siStreamName :: Lens' StreamInfo (Maybe Text)
- data StreamNameCondition
- streamNameCondition :: StreamNameCondition
- sncComparisonOperator :: Lens' StreamNameCondition (Maybe ComparisonOperator)
- sncComparisonValue :: Lens' StreamNameCondition (Maybe Text)
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
_InvalidDeviceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Not implemented.
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
_DeviceStreamLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Not implemented.
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
ComparisonOperator
data ComparisonOperator Source #
StreamStatus
data StreamStatus Source #
UpdateDataRetentionOperation
data UpdateDataRetentionOperation Source #
StreamInfo
data StreamInfo Source #
An object describing a Kinesis video stream.
See: streamInfo
smart constructor.
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
- TheMediaType
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.
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.
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 theBEGINS_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.
sncComparisonValue :: Lens' StreamNameCondition (Maybe Text) Source #
A value to compare.