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 |
Synopsis
- kinesisVideoMedia :: Service
- _ConnectionLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEndpointException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data StartSelectorType
- data StartSelector
- startSelector :: StartSelectorType -> StartSelector
- ssContinuationToken :: Lens' StartSelector (Maybe Text)
- ssAfterFragmentNumber :: Lens' StartSelector (Maybe Text)
- ssStartTimestamp :: Lens' StartSelector (Maybe UTCTime)
- ssStartSelectorType :: Lens' StartSelector StartSelectorType
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
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 previousGetMedia
request terminated, you can use this tag value in your nextGetMedia
request. The API then starts returning chunks starting where the last API ended.
See: startSelector
smart constructor.
Instances
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 previousGetMedia
response. TheGetMedia
API then starts with the chunk identified by the continuation token.ssAfterFragmentNumber
- Specifies the fragment number from where you want theGetMedia
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 thestartSelectorType
. TheGetMedia
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 theStartFragmentNumber
. * 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 addingStartTimestamp
. * 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.