libZSservicesZSamazonka-kinesis-video-mediaZSamazonka-kinesis-video-media
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KinesisVideoMedia.Types

Description

 
Synopsis

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 #

Instances

Instances details
Eq StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

Ord StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

Read StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

Show StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

Generic StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

Associated Types

type Rep StartSelectorType :: Type -> Type #

NFData StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

Methods

rnf :: StartSelectorType -> () #

Hashable StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToJSON StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToJSONKey StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

FromJSON StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

FromJSONKey StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToLog StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToHeader StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToQuery StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

FromXML StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToXML StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToByteString StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

FromText StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

ToText StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

type Rep StartSelectorType Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelectorType

type Rep StartSelectorType = D1 ('MetaData "StartSelectorType" "Amazonka.KinesisVideoMedia.Types.StartSelectorType" "libZSservicesZSamazonka-kinesis-video-mediaZSamazonka-kinesis-video-media" 'True) (C1 ('MetaCons "StartSelectorType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStartSelectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

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 previous GetMedia request terminated, you can use this tag value in your next GetMedia request. The API then starts returning chunks starting where the last API ended.

See: newStartSelector smart constructor.

Constructors

StartSelector' 

Fields

  • continuationToken :: Maybe Text

    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.

  • afterFragmentNumber :: Maybe Text

    Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

  • startTimestamp :: Maybe POSIX

    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.

  • startSelectorType :: 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.

Instances

Instances details
Eq StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

Read StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

Show StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

Generic StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

Associated Types

type Rep StartSelector :: Type -> Type #

NFData StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

Methods

rnf :: StartSelector -> () #

Hashable StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

ToJSON StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

type Rep StartSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoMedia.Types.StartSelector

type Rep StartSelector = D1 ('MetaData "StartSelector" "Amazonka.KinesisVideoMedia.Types.StartSelector" "libZSservicesZSamazonka-kinesis-video-mediaZSamazonka-kinesis-video-media" 'False) (C1 ('MetaCons "StartSelector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "continuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "afterFragmentNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "startTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "startSelectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StartSelectorType))))

newStartSelector Source #

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.