Copyright | (c) 2013-2021 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 |
Synopsis
- defaultService :: 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
- newtype StartSelectorType where
- StartSelectorType' { }
- pattern StartSelectorType_CONTINUATION_TOKEN :: StartSelectorType
- pattern StartSelectorType_EARLIEST :: StartSelectorType
- pattern StartSelectorType_FRAGMENT_NUMBER :: StartSelectorType
- pattern StartSelectorType_NOW :: StartSelectorType
- pattern StartSelectorType_PRODUCER_TIMESTAMP :: StartSelectorType
- pattern StartSelectorType_SERVER_TIMESTAMP :: StartSelectorType
- data StartSelector = StartSelector' {}
- newStartSelector :: StartSelectorType -> StartSelector
- startSelector_continuationToken :: Lens' StartSelector (Maybe Text)
- startSelector_afterFragmentNumber :: Lens' StartSelector (Maybe Text)
- startSelector_startTimestamp :: Lens' StartSelector (Maybe UTCTime)
- startSelector_startSelectorType :: Lens' StartSelector StartSelectorType
Service Configuration
defaultService :: 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
newtype StartSelectorType Source #
pattern StartSelectorType_CONTINUATION_TOKEN :: StartSelectorType | |
pattern StartSelectorType_EARLIEST :: StartSelectorType | |
pattern StartSelectorType_FRAGMENT_NUMBER :: StartSelectorType | |
pattern StartSelectorType_NOW :: StartSelectorType | |
pattern StartSelectorType_PRODUCER_TIMESTAMP :: StartSelectorType | |
pattern StartSelectorType_SERVER_TIMESTAMP :: StartSelectorType |
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 timestamp (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: newStartSelector
smart constructor.
StartSelector' | |
|
Instances
Create a value of StartSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:continuationToken:StartSelector'
, startSelector_continuationToken
- 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.
$sel:afterFragmentNumber:StartSelector'
, startSelector_afterFragmentNumber
- Specifies the fragment number from where you want the GetMedia
API to
start returning the fragments.
$sel:startTimestamp:StartSelector'
, startSelector_startTimestamp
- A timestamp 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 timestamp.
$sel:startSelectorType:StartSelector'
, 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 after a specific fragment.
You must also specify the
AfterFragmentNumber
parameter. - PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk
containing a fragment with the specified producer or server
timestamp. You specify the timestamp by adding
StartTimestamp
. - CONTINUATION_TOKEN - Read using the specified continuation token.
If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the
startSelectorType
, you don't provide any additional information in
the startSelector
.
startSelector_continuationToken :: 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.
startSelector_afterFragmentNumber :: Lens' StartSelector (Maybe Text) Source #
Specifies the fragment number from where you want the GetMedia
API to
start returning the fragments.
startSelector_startTimestamp :: Lens' StartSelector (Maybe UTCTime) Source #
A timestamp 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 timestamp.
startSelector_startSelectorType :: 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 after a specific fragment.
You must also specify the
AfterFragmentNumber
parameter. - PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk
containing a fragment with the specified producer or server
timestamp. You specify the timestamp by adding
StartTimestamp
. - CONTINUATION_TOKEN - Read using the specified continuation token.
If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the
startSelectorType
, you don't provide any additional information in
the startSelector
.