Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- ChannelLatencyMode
- ChannelType
- RecordingConfigurationState
- RecordingMode
- StreamHealth
- StreamState
- AudioConfiguration
- BatchError
- Channel
- ChannelSummary
- DestinationConfiguration
- IngestConfiguration
- PlaybackKeyPair
- PlaybackKeyPairSummary
- RecordingConfiguration
- RecordingConfigurationSummary
- S3DestinationConfiguration
- Stream
- StreamEvent
- StreamFilters
- StreamKey
- StreamKeySummary
- StreamSession
- StreamSessionSummary
- StreamSummary
- ThumbnailConfiguration
- VideoConfiguration
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ChannelNotBroadcasting :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _PendingVerification :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _StreamUnavailable :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype ChannelLatencyMode where
- ChannelLatencyMode' { }
- pattern ChannelLatencyMode_LOW :: ChannelLatencyMode
- pattern ChannelLatencyMode_NORMAL :: ChannelLatencyMode
- newtype ChannelType where
- ChannelType' { }
- pattern ChannelType_BASIC :: ChannelType
- pattern ChannelType_STANDARD :: ChannelType
- newtype RecordingConfigurationState where
- newtype RecordingMode where
- RecordingMode' { }
- pattern RecordingMode_DISABLED :: RecordingMode
- pattern RecordingMode_INTERVAL :: RecordingMode
- newtype StreamHealth where
- StreamHealth' { }
- pattern StreamHealth_HEALTHY :: StreamHealth
- pattern StreamHealth_STARVING :: StreamHealth
- pattern StreamHealth_UNKNOWN :: StreamHealth
- newtype StreamState where
- StreamState' { }
- pattern StreamState_LIVE :: StreamState
- pattern StreamState_OFFLINE :: StreamState
- data AudioConfiguration = AudioConfiguration' {}
- newAudioConfiguration :: AudioConfiguration
- audioConfiguration_channels :: Lens' AudioConfiguration (Maybe Integer)
- audioConfiguration_codec :: Lens' AudioConfiguration (Maybe Text)
- audioConfiguration_sampleRate :: Lens' AudioConfiguration (Maybe Integer)
- audioConfiguration_targetBitrate :: Lens' AudioConfiguration (Maybe Integer)
- data BatchError = BatchError' {}
- newBatchError :: BatchError
- batchError_arn :: Lens' BatchError (Maybe Text)
- batchError_code :: Lens' BatchError (Maybe Text)
- batchError_message :: Lens' BatchError (Maybe Text)
- data Channel = Channel' {}
- newChannel :: Channel
- channel_arn :: Lens' Channel (Maybe Text)
- channel_authorized :: Lens' Channel (Maybe Bool)
- channel_ingestEndpoint :: Lens' Channel (Maybe Text)
- channel_latencyMode :: Lens' Channel (Maybe ChannelLatencyMode)
- channel_name :: Lens' Channel (Maybe Text)
- channel_playbackUrl :: Lens' Channel (Maybe Text)
- channel_recordingConfigurationArn :: Lens' Channel (Maybe Text)
- channel_tags :: Lens' Channel (Maybe (HashMap Text Text))
- channel_type :: Lens' Channel (Maybe ChannelType)
- data ChannelSummary = ChannelSummary' {
- arn :: Maybe Text
- authorized :: Maybe Bool
- latencyMode :: Maybe ChannelLatencyMode
- name :: Maybe Text
- recordingConfigurationArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- newChannelSummary :: ChannelSummary
- channelSummary_arn :: Lens' ChannelSummary (Maybe Text)
- channelSummary_authorized :: Lens' ChannelSummary (Maybe Bool)
- channelSummary_latencyMode :: Lens' ChannelSummary (Maybe ChannelLatencyMode)
- channelSummary_name :: Lens' ChannelSummary (Maybe Text)
- channelSummary_recordingConfigurationArn :: Lens' ChannelSummary (Maybe Text)
- channelSummary_tags :: Lens' ChannelSummary (Maybe (HashMap Text Text))
- data DestinationConfiguration = DestinationConfiguration' {}
- newDestinationConfiguration :: DestinationConfiguration
- destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration)
- data IngestConfiguration = IngestConfiguration' {}
- newIngestConfiguration :: IngestConfiguration
- ingestConfiguration_audio :: Lens' IngestConfiguration (Maybe AudioConfiguration)
- ingestConfiguration_video :: Lens' IngestConfiguration (Maybe VideoConfiguration)
- data PlaybackKeyPair = PlaybackKeyPair' {}
- newPlaybackKeyPair :: PlaybackKeyPair
- playbackKeyPair_arn :: Lens' PlaybackKeyPair (Maybe Text)
- playbackKeyPair_fingerprint :: Lens' PlaybackKeyPair (Maybe Text)
- playbackKeyPair_name :: Lens' PlaybackKeyPair (Maybe Text)
- playbackKeyPair_tags :: Lens' PlaybackKeyPair (Maybe (HashMap Text Text))
- data PlaybackKeyPairSummary = PlaybackKeyPairSummary' {}
- newPlaybackKeyPairSummary :: PlaybackKeyPairSummary
- playbackKeyPairSummary_arn :: Lens' PlaybackKeyPairSummary (Maybe Text)
- playbackKeyPairSummary_name :: Lens' PlaybackKeyPairSummary (Maybe Text)
- playbackKeyPairSummary_tags :: Lens' PlaybackKeyPairSummary (Maybe (HashMap Text Text))
- data RecordingConfiguration = RecordingConfiguration' {}
- newRecordingConfiguration :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfiguration
- recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text)
- recordingConfiguration_recordingReconnectWindowSeconds :: Lens' RecordingConfiguration (Maybe Natural)
- recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text))
- recordingConfiguration_thumbnailConfiguration :: Lens' RecordingConfiguration (Maybe ThumbnailConfiguration)
- recordingConfiguration_arn :: Lens' RecordingConfiguration Text
- recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration
- recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState
- data RecordingConfigurationSummary = RecordingConfigurationSummary' {}
- newRecordingConfigurationSummary :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfigurationSummary
- recordingConfigurationSummary_name :: Lens' RecordingConfigurationSummary (Maybe Text)
- recordingConfigurationSummary_tags :: Lens' RecordingConfigurationSummary (Maybe (HashMap Text Text))
- recordingConfigurationSummary_arn :: Lens' RecordingConfigurationSummary Text
- recordingConfigurationSummary_destinationConfiguration :: Lens' RecordingConfigurationSummary DestinationConfiguration
- recordingConfigurationSummary_state :: Lens' RecordingConfigurationSummary RecordingConfigurationState
- data S3DestinationConfiguration = S3DestinationConfiguration' {
- bucketName :: Text
- newS3DestinationConfiguration :: Text -> S3DestinationConfiguration
- s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text
- data Stream = Stream' {}
- newStream :: Stream
- stream_channelArn :: Lens' Stream (Maybe Text)
- stream_health :: Lens' Stream (Maybe StreamHealth)
- stream_playbackUrl :: Lens' Stream (Maybe Text)
- stream_startTime :: Lens' Stream (Maybe UTCTime)
- stream_state :: Lens' Stream (Maybe StreamState)
- stream_streamId :: Lens' Stream (Maybe Text)
- stream_viewerCount :: Lens' Stream (Maybe Integer)
- data StreamEvent = StreamEvent' {}
- newStreamEvent :: StreamEvent
- streamEvent_eventTime :: Lens' StreamEvent (Maybe UTCTime)
- streamEvent_name :: Lens' StreamEvent (Maybe Text)
- streamEvent_type :: Lens' StreamEvent (Maybe Text)
- data StreamFilters = StreamFilters' {}
- newStreamFilters :: StreamFilters
- streamFilters_health :: Lens' StreamFilters (Maybe StreamHealth)
- data StreamKey = StreamKey' {}
- newStreamKey :: StreamKey
- streamKey_arn :: Lens' StreamKey (Maybe Text)
- streamKey_channelArn :: Lens' StreamKey (Maybe Text)
- streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text))
- streamKey_value :: Lens' StreamKey (Maybe Text)
- data StreamKeySummary = StreamKeySummary' {}
- newStreamKeySummary :: StreamKeySummary
- streamKeySummary_arn :: Lens' StreamKeySummary (Maybe Text)
- streamKeySummary_channelArn :: Lens' StreamKeySummary (Maybe Text)
- streamKeySummary_tags :: Lens' StreamKeySummary (Maybe (HashMap Text Text))
- data StreamSession = StreamSession' {}
- newStreamSession :: StreamSession
- streamSession_channel :: Lens' StreamSession (Maybe Channel)
- streamSession_endTime :: Lens' StreamSession (Maybe UTCTime)
- streamSession_ingestConfiguration :: Lens' StreamSession (Maybe IngestConfiguration)
- streamSession_recordingConfiguration :: Lens' StreamSession (Maybe RecordingConfiguration)
- streamSession_startTime :: Lens' StreamSession (Maybe UTCTime)
- streamSession_streamId :: Lens' StreamSession (Maybe Text)
- streamSession_truncatedEvents :: Lens' StreamSession (Maybe [StreamEvent])
- data StreamSessionSummary = StreamSessionSummary' {}
- newStreamSessionSummary :: StreamSessionSummary
- streamSessionSummary_endTime :: Lens' StreamSessionSummary (Maybe UTCTime)
- streamSessionSummary_hasErrorEvent :: Lens' StreamSessionSummary (Maybe Bool)
- streamSessionSummary_startTime :: Lens' StreamSessionSummary (Maybe UTCTime)
- streamSessionSummary_streamId :: Lens' StreamSessionSummary (Maybe Text)
- data StreamSummary = StreamSummary' {}
- newStreamSummary :: StreamSummary
- streamSummary_channelArn :: Lens' StreamSummary (Maybe Text)
- streamSummary_health :: Lens' StreamSummary (Maybe StreamHealth)
- streamSummary_startTime :: Lens' StreamSummary (Maybe UTCTime)
- streamSummary_state :: Lens' StreamSummary (Maybe StreamState)
- streamSummary_streamId :: Lens' StreamSummary (Maybe Text)
- streamSummary_viewerCount :: Lens' StreamSummary (Maybe Integer)
- data ThumbnailConfiguration = ThumbnailConfiguration' {}
- newThumbnailConfiguration :: ThumbnailConfiguration
- thumbnailConfiguration_recordingMode :: Lens' ThumbnailConfiguration (Maybe RecordingMode)
- thumbnailConfiguration_targetIntervalSeconds :: Lens' ThumbnailConfiguration (Maybe Natural)
- data VideoConfiguration = VideoConfiguration' {}
- newVideoConfiguration :: VideoConfiguration
- videoConfiguration_avcLevel :: Lens' VideoConfiguration (Maybe Text)
- videoConfiguration_avcProfile :: Lens' VideoConfiguration (Maybe Text)
- videoConfiguration_codec :: Lens' VideoConfiguration (Maybe Text)
- videoConfiguration_encoder :: Lens' VideoConfiguration (Maybe Text)
- videoConfiguration_targetBitrate :: Lens' VideoConfiguration (Maybe Integer)
- videoConfiguration_targetFramerate :: Lens' VideoConfiguration (Maybe Integer)
- videoConfiguration_videoHeight :: Lens' VideoConfiguration (Maybe Integer)
- videoConfiguration_videoWidth :: Lens' VideoConfiguration (Maybe Integer)
Service Configuration
defaultService :: Service Source #
API version 2020-07-14
of the Amazon Interactive Video Service SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
_ChannelNotBroadcasting :: AsError a => Fold a ServiceError Source #
_ConflictException :: AsError a => Fold a ServiceError Source #
_InternalServerException :: AsError a => Fold a ServiceError Source #
_PendingVerification :: AsError a => Fold a ServiceError Source #
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
_StreamUnavailable :: AsError a => Fold a ServiceError Source #
_ThrottlingException :: AsError a => Fold a ServiceError Source #
_ValidationException :: AsError a => Fold a ServiceError Source #
ChannelLatencyMode
newtype ChannelLatencyMode Source #
pattern ChannelLatencyMode_LOW :: ChannelLatencyMode | |
pattern ChannelLatencyMode_NORMAL :: ChannelLatencyMode |
Instances
ChannelType
newtype ChannelType Source #
pattern ChannelType_BASIC :: ChannelType | |
pattern ChannelType_STANDARD :: ChannelType |
Instances
RecordingConfigurationState
newtype RecordingConfigurationState Source #
Instances
RecordingMode
newtype RecordingMode Source #
pattern RecordingMode_DISABLED :: RecordingMode | |
pattern RecordingMode_INTERVAL :: RecordingMode |
Instances
StreamHealth
newtype StreamHealth Source #
pattern StreamHealth_HEALTHY :: StreamHealth | |
pattern StreamHealth_STARVING :: StreamHealth | |
pattern StreamHealth_UNKNOWN :: StreamHealth |
Instances
StreamState
newtype StreamState Source #
pattern StreamState_LIVE :: StreamState | |
pattern StreamState_OFFLINE :: StreamState |
Instances
AudioConfiguration
data AudioConfiguration Source #
Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.
See: newAudioConfiguration
smart constructor.
Instances
newAudioConfiguration :: AudioConfiguration Source #
Create a value of AudioConfiguration
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:channels:AudioConfiguration'
, audioConfiguration_channels
- Number of audio channels.
$sel:codec:AudioConfiguration'
, audioConfiguration_codec
- Codec used for the audio encoding.
$sel:sampleRate:AudioConfiguration'
, audioConfiguration_sampleRate
- Number of audio samples recorded per second.
$sel:targetBitrate:AudioConfiguration'
, audioConfiguration_targetBitrate
- The expected ingest bitrate (bits per second). This is configured in the
encoder.
audioConfiguration_channels :: Lens' AudioConfiguration (Maybe Integer) Source #
Number of audio channels.
audioConfiguration_codec :: Lens' AudioConfiguration (Maybe Text) Source #
Codec used for the audio encoding.
audioConfiguration_sampleRate :: Lens' AudioConfiguration (Maybe Integer) Source #
Number of audio samples recorded per second.
audioConfiguration_targetBitrate :: Lens' AudioConfiguration (Maybe Integer) Source #
The expected ingest bitrate (bits per second). This is configured in the encoder.
BatchError
data BatchError Source #
Error related to a specific channel, specified by its ARN.
See: newBatchError
smart constructor.
Instances
newBatchError :: BatchError Source #
Create a value of BatchError
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:arn:BatchError'
, batchError_arn
- Channel ARN.
$sel:code:BatchError'
, batchError_code
- Error code.
$sel:message:BatchError'
, batchError_message
- Error message, determined by the application.
batchError_arn :: Lens' BatchError (Maybe Text) Source #
Channel ARN.
batchError_code :: Lens' BatchError (Maybe Text) Source #
Error code.
batchError_message :: Lens' BatchError (Maybe Text) Source #
Error message, determined by the application.
Channel
Object specifying a channel.
See: newChannel
smart constructor.
Channel' | |
|
Instances
newChannel :: Channel Source #
Create a value of Channel
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:arn:Channel'
, channel_arn
- Channel ARN.
$sel:authorized:Channel'
, channel_authorized
- Whether the channel is private (enabled for playback authorization).
Default: false
.
$sel:ingestEndpoint:Channel'
, channel_ingestEndpoint
- Channel ingest endpoint, part of the definition of an ingest server,
used when you set up streaming software.
$sel:latencyMode:Channel'
, channel_latencyMode
- Channel latency mode. Use NORMAL
to broadcast and deliver live video
up to Full HD. Use LOW
for near-real-time interaction with viewers.
Default: LOW
. (Note: In the Amazon IVS console, LOW
and NORMAL
correspond to Ultra-low and Standard, respectively.)
$sel:name:Channel'
, channel_name
- Channel name.
$sel:playbackUrl:Channel'
, channel_playbackUrl
- Channel playback URL.
$sel:recordingConfigurationArn:Channel'
, channel_recordingConfigurationArn
- Recording-configuration ARN. A value other than an empty string
indicates that recording is enabled. Default: "" (empty string,
recording is disabled).
$sel:tags:Channel'
, channel_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
$sel:type':Channel'
, channel_type
- Channel type, which determines the allowable resolution and bitrate. /If
you exceed the allowable resolution or bitrate, the stream probably will
disconnect immediately./ Default: STANDARD
. Valid values:
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.BASIC
: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
channel_authorized :: Lens' Channel (Maybe Bool) Source #
Whether the channel is private (enabled for playback authorization).
Default: false
.
channel_ingestEndpoint :: Lens' Channel (Maybe Text) Source #
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
channel_latencyMode :: Lens' Channel (Maybe ChannelLatencyMode) Source #
Channel latency mode. Use NORMAL
to broadcast and deliver live video
up to Full HD. Use LOW
for near-real-time interaction with viewers.
Default: LOW
. (Note: In the Amazon IVS console, LOW
and NORMAL
correspond to Ultra-low and Standard, respectively.)
channel_recordingConfigurationArn :: Lens' Channel (Maybe Text) Source #
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
channel_tags :: Lens' Channel (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
channel_type :: Lens' Channel (Maybe ChannelType) Source #
Channel type, which determines the allowable resolution and bitrate. /If
you exceed the allowable resolution or bitrate, the stream probably will
disconnect immediately./ Default: STANDARD
. Valid values:
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.BASIC
: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
ChannelSummary
data ChannelSummary Source #
Summary information about a channel.
See: newChannelSummary
smart constructor.
ChannelSummary' | |
|
Instances
newChannelSummary :: ChannelSummary Source #
Create a value of ChannelSummary
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:arn:ChannelSummary'
, channelSummary_arn
- Channel ARN.
$sel:authorized:ChannelSummary'
, channelSummary_authorized
- Whether the channel is private (enabled for playback authorization).
Default: false
.
$sel:latencyMode:ChannelSummary'
, channelSummary_latencyMode
- Channel latency mode. Use NORMAL
to broadcast and deliver live video
up to Full HD. Use LOW
for near-real-time interaction with viewers.
Default: LOW
. (Note: In the Amazon IVS console, LOW
and NORMAL
correspond to Ultra-low and Standard, respectively.)
$sel:name:ChannelSummary'
, channelSummary_name
- Channel name.
$sel:recordingConfigurationArn:ChannelSummary'
, channelSummary_recordingConfigurationArn
- Recording-configuration ARN. A value other than an empty string
indicates that recording is enabled. Default: "" (empty string,
recording is disabled).
$sel:tags:ChannelSummary'
, channelSummary_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
channelSummary_arn :: Lens' ChannelSummary (Maybe Text) Source #
Channel ARN.
channelSummary_authorized :: Lens' ChannelSummary (Maybe Bool) Source #
Whether the channel is private (enabled for playback authorization).
Default: false
.
channelSummary_latencyMode :: Lens' ChannelSummary (Maybe ChannelLatencyMode) Source #
Channel latency mode. Use NORMAL
to broadcast and deliver live video
up to Full HD. Use LOW
for near-real-time interaction with viewers.
Default: LOW
. (Note: In the Amazon IVS console, LOW
and NORMAL
correspond to Ultra-low and Standard, respectively.)
channelSummary_name :: Lens' ChannelSummary (Maybe Text) Source #
Channel name.
channelSummary_recordingConfigurationArn :: Lens' ChannelSummary (Maybe Text) Source #
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
channelSummary_tags :: Lens' ChannelSummary (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
DestinationConfiguration
data DestinationConfiguration Source #
A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
See: newDestinationConfiguration
smart constructor.
DestinationConfiguration' | |
|
Instances
newDestinationConfiguration :: DestinationConfiguration Source #
Create a value of DestinationConfiguration
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:s3:DestinationConfiguration'
, destinationConfiguration_s3
- An S3 destination configuration where recorded videos will be stored.
destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration) Source #
An S3 destination configuration where recorded videos will be stored.
IngestConfiguration
data IngestConfiguration Source #
Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.
See: newIngestConfiguration
smart constructor.
IngestConfiguration' | |
|
Instances
newIngestConfiguration :: IngestConfiguration Source #
Create a value of IngestConfiguration
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:audio:IngestConfiguration'
, ingestConfiguration_audio
- Encoder settings for audio.
$sel:video:IngestConfiguration'
, ingestConfiguration_video
- Encoder settings for video.
ingestConfiguration_audio :: Lens' IngestConfiguration (Maybe AudioConfiguration) Source #
Encoder settings for audio.
ingestConfiguration_video :: Lens' IngestConfiguration (Maybe VideoConfiguration) Source #
Encoder settings for video.
PlaybackKeyPair
data PlaybackKeyPair Source #
A key pair used to sign and validate a playback authorization token.
See: newPlaybackKeyPair
smart constructor.
PlaybackKeyPair' | |
|
Instances
newPlaybackKeyPair :: PlaybackKeyPair Source #
Create a value of PlaybackKeyPair
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:arn:PlaybackKeyPair'
, playbackKeyPair_arn
- Key-pair ARN.
$sel:fingerprint:PlaybackKeyPair'
, playbackKeyPair_fingerprint
- Key-pair identifier.
$sel:name:PlaybackKeyPair'
, playbackKeyPair_name
- Playback-key-pair name. The value does not need to be unique.
$sel:tags:PlaybackKeyPair'
, playbackKeyPair_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
playbackKeyPair_arn :: Lens' PlaybackKeyPair (Maybe Text) Source #
Key-pair ARN.
playbackKeyPair_fingerprint :: Lens' PlaybackKeyPair (Maybe Text) Source #
Key-pair identifier.
playbackKeyPair_name :: Lens' PlaybackKeyPair (Maybe Text) Source #
Playback-key-pair name. The value does not need to be unique.
playbackKeyPair_tags :: Lens' PlaybackKeyPair (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
PlaybackKeyPairSummary
data PlaybackKeyPairSummary Source #
Summary information about a playback key pair.
See: newPlaybackKeyPairSummary
smart constructor.
PlaybackKeyPairSummary' | |
|
Instances
newPlaybackKeyPairSummary :: PlaybackKeyPairSummary Source #
Create a value of PlaybackKeyPairSummary
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:arn:PlaybackKeyPairSummary'
, playbackKeyPairSummary_arn
- Key-pair ARN.
$sel:name:PlaybackKeyPairSummary'
, playbackKeyPairSummary_name
- Playback-key-pair name. The value does not need to be unique.
$sel:tags:PlaybackKeyPairSummary'
, playbackKeyPairSummary_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
playbackKeyPairSummary_arn :: Lens' PlaybackKeyPairSummary (Maybe Text) Source #
Key-pair ARN.
playbackKeyPairSummary_name :: Lens' PlaybackKeyPairSummary (Maybe Text) Source #
Playback-key-pair name. The value does not need to be unique.
playbackKeyPairSummary_tags :: Lens' PlaybackKeyPairSummary (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
RecordingConfiguration
data RecordingConfiguration Source #
An object representing a configuration to record a channel stream.
See: newRecordingConfiguration
smart constructor.
RecordingConfiguration' | |
|
Instances
newRecordingConfiguration Source #
Create a value of RecordingConfiguration
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:name:RecordingConfiguration'
, recordingConfiguration_name
- Recording-configuration name. The value does not need to be unique.
$sel:recordingReconnectWindowSeconds:RecordingConfiguration'
, recordingConfiguration_recordingReconnectWindowSeconds
- If a broadcast disconnects and then reconnects within the specified
interval, the multiple streams will be considered a single broadcast and
merged together. Default: 0.
$sel:tags:RecordingConfiguration'
, recordingConfiguration_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
$sel:thumbnailConfiguration:RecordingConfiguration'
, recordingConfiguration_thumbnailConfiguration
- A complex type that allows you to enable/disable the recording of
thumbnails for a live session and modify the interval at which
thumbnails are generated for the live session.
$sel:arn:RecordingConfiguration'
, recordingConfiguration_arn
- Recording-configuration ARN.
$sel:destinationConfiguration:RecordingConfiguration'
, recordingConfiguration_destinationConfiguration
- A complex type that contains information about where recorded video will
be stored.
$sel:state:RecordingConfiguration'
, recordingConfiguration_state
- Indicates the current state of the recording configuration. When the
state is ACTIVE
, the configuration is ready for recording a channel
stream.
recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text) Source #
Recording-configuration name. The value does not need to be unique.
recordingConfiguration_recordingReconnectWindowSeconds :: Lens' RecordingConfiguration (Maybe Natural) Source #
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
recordingConfiguration_thumbnailConfiguration :: Lens' RecordingConfiguration (Maybe ThumbnailConfiguration) Source #
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
recordingConfiguration_arn :: Lens' RecordingConfiguration Text Source #
Recording-configuration ARN.
recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration Source #
A complex type that contains information about where recorded video will be stored.
recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState Source #
Indicates the current state of the recording configuration. When the
state is ACTIVE
, the configuration is ready for recording a channel
stream.
RecordingConfigurationSummary
data RecordingConfigurationSummary Source #
Summary information about a RecordingConfiguration.
See: newRecordingConfigurationSummary
smart constructor.
RecordingConfigurationSummary' | |
|
Instances
newRecordingConfigurationSummary Source #
:: Text | |
-> DestinationConfiguration |
|
-> RecordingConfigurationState | |
-> RecordingConfigurationSummary |
Create a value of RecordingConfigurationSummary
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:name:RecordingConfigurationSummary'
, recordingConfigurationSummary_name
- Recording-configuration name. The value does not need to be unique.
$sel:tags:RecordingConfigurationSummary'
, recordingConfigurationSummary_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
$sel:arn:RecordingConfigurationSummary'
, recordingConfigurationSummary_arn
- Recording-configuration ARN.
$sel:destinationConfiguration:RecordingConfigurationSummary'
, recordingConfigurationSummary_destinationConfiguration
- A complex type that contains information about where recorded video will
be stored.
$sel:state:RecordingConfigurationSummary'
, recordingConfigurationSummary_state
- Indicates the current state of the recording configuration. When the
state is ACTIVE
, the configuration is ready for recording a channel
stream.
recordingConfigurationSummary_name :: Lens' RecordingConfigurationSummary (Maybe Text) Source #
Recording-configuration name. The value does not need to be unique.
recordingConfigurationSummary_tags :: Lens' RecordingConfigurationSummary (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
recordingConfigurationSummary_arn :: Lens' RecordingConfigurationSummary Text Source #
Recording-configuration ARN.
recordingConfigurationSummary_destinationConfiguration :: Lens' RecordingConfigurationSummary DestinationConfiguration Source #
A complex type that contains information about where recorded video will be stored.
recordingConfigurationSummary_state :: Lens' RecordingConfigurationSummary RecordingConfigurationState Source #
Indicates the current state of the recording configuration. When the
state is ACTIVE
, the configuration is ready for recording a channel
stream.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
A complex type that describes an S3 location where recorded videos will be stored.
See: newS3DestinationConfiguration
smart constructor.
S3DestinationConfiguration' | |
|
Instances
newS3DestinationConfiguration Source #
Create a value of S3DestinationConfiguration
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:bucketName:S3DestinationConfiguration'
, s3DestinationConfiguration_bucketName
- Location (S3 bucket name) where recorded videos will be stored.
s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text Source #
Location (S3 bucket name) where recorded videos will be stored.
Stream
Specifies a live video stream that has been ingested and distributed.
See: newStream
smart constructor.
Stream' | |
|
Instances
Create a value of Stream
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:channelArn:Stream'
, stream_channelArn
- Channel ARN for the stream.
$sel:health:Stream'
, stream_health
- The stream’s health.
$sel:playbackUrl:Stream'
, stream_playbackUrl
- URL of the master playlist, required by the video player to play the HLS
stream.
$sel:startTime:Stream'
, stream_startTime
- Time of the stream’s start. This is an ISO 8601 timestamp; /note that
this is returned as a string/.
$sel:state:Stream'
, stream_state
- The stream’s state.
$sel:streamId:Stream'
, stream_streamId
- Unique identifier for a live or previously live stream in the specified
channel.
$sel:viewerCount:Stream'
, stream_viewerCount
- A count of concurrent views of the stream. Typically, a new view appears
in viewerCount
within 15 seconds of when video playback starts and a
view is removed from viewerCount
within 1 minute of when video
playback ends. A value of -1 indicates that the request timed out; in
this case, retry.
stream_health :: Lens' Stream (Maybe StreamHealth) Source #
The stream’s health.
stream_playbackUrl :: Lens' Stream (Maybe Text) Source #
URL of the master playlist, required by the video player to play the HLS stream.
stream_startTime :: Lens' Stream (Maybe UTCTime) Source #
Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.
stream_state :: Lens' Stream (Maybe StreamState) Source #
The stream’s state.
stream_streamId :: Lens' Stream (Maybe Text) Source #
Unique identifier for a live or previously live stream in the specified channel.
stream_viewerCount :: Lens' Stream (Maybe Integer) Source #
A count of concurrent views of the stream. Typically, a new view appears
in viewerCount
within 15 seconds of when video playback starts and a
view is removed from viewerCount
within 1 minute of when video
playback ends. A value of -1 indicates that the request timed out; in
this case, retry.
StreamEvent
data StreamEvent Source #
Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.
See: newStreamEvent
smart constructor.
Instances
newStreamEvent :: StreamEvent Source #
Create a value of StreamEvent
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:eventTime:StreamEvent'
, streamEvent_eventTime
- Time when the event occurred. This is an ISO 8601 timestamp; /note that
this is returned as a string/.
$sel:name:StreamEvent'
, streamEvent_name
- Name that identifies the stream event within a type
.
$sel:type':StreamEvent'
, streamEvent_type
- Logical group for certain events.
streamEvent_eventTime :: Lens' StreamEvent (Maybe UTCTime) Source #
Time when the event occurred. This is an ISO 8601 timestamp; /note that this is returned as a string/.
streamEvent_name :: Lens' StreamEvent (Maybe Text) Source #
Name that identifies the stream event within a type
.
streamEvent_type :: Lens' StreamEvent (Maybe Text) Source #
Logical group for certain events.
StreamFilters
data StreamFilters Source #
Object specifying the stream attribute on which to filter.
See: newStreamFilters
smart constructor.
StreamFilters' | |
|
Instances
newStreamFilters :: StreamFilters Source #
Create a value of StreamFilters
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:health:StreamFilters'
, streamFilters_health
- The stream’s health.
streamFilters_health :: Lens' StreamFilters (Maybe StreamHealth) Source #
The stream’s health.
StreamKey
Object specifying a stream key.
See: newStreamKey
smart constructor.
StreamKey' | |
|
Instances
FromJSON StreamKey Source # | |
Generic StreamKey Source # | |
Show StreamKey Source # | |
NFData StreamKey Source # | |
Defined in Amazonka.IVS.Types.StreamKey | |
Eq StreamKey Source # | |
Hashable StreamKey Source # | |
Defined in Amazonka.IVS.Types.StreamKey | |
type Rep StreamKey Source # | |
Defined in Amazonka.IVS.Types.StreamKey type Rep StreamKey = D1 ('MetaData "StreamKey" "Amazonka.IVS.Types.StreamKey" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "StreamKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) |
newStreamKey :: StreamKey Source #
Create a value of StreamKey
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:arn:StreamKey'
, streamKey_arn
- Stream-key ARN.
$sel:channelArn:StreamKey'
, streamKey_channelArn
- Channel ARN for the stream.
$sel:tags:StreamKey'
, streamKey_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
$sel:value:StreamKey'
, streamKey_value
- Stream-key value.
streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
StreamKeySummary
data StreamKeySummary Source #
Summary information about a stream key.
See: newStreamKeySummary
smart constructor.
StreamKeySummary' | |
|
Instances
newStreamKeySummary :: StreamKeySummary Source #
Create a value of StreamKeySummary
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:arn:StreamKeySummary'
, streamKeySummary_arn
- Stream-key ARN.
$sel:channelArn:StreamKeySummary'
, streamKeySummary_channelArn
- Channel ARN for the stream.
$sel:tags:StreamKeySummary'
, streamKeySummary_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
streamKeySummary_arn :: Lens' StreamKeySummary (Maybe Text) Source #
Stream-key ARN.
streamKeySummary_channelArn :: Lens' StreamKeySummary (Maybe Text) Source #
Channel ARN for the stream.
streamKeySummary_tags :: Lens' StreamKeySummary (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
StreamSession
data StreamSession Source #
Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.
See: newStreamSession
smart constructor.
StreamSession' | |
|
Instances
newStreamSession :: StreamSession Source #
Create a value of StreamSession
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:channel:StreamSession'
, streamSession_channel
- The properties of the channel at the time of going live.
$sel:endTime:StreamSession'
, streamSession_endTime
- Time when the channel went offline. This is an ISO 8601 timestamp; /note
that this is returned as a string/. For live streams, this is NULL
.
$sel:ingestConfiguration:StreamSession'
, streamSession_ingestConfiguration
- The properties of the incoming RTMP stream for the stream.
$sel:recordingConfiguration:StreamSession'
, streamSession_recordingConfiguration
- The properties of recording the live stream.
$sel:startTime:StreamSession'
, streamSession_startTime
- Time when the channel went live. This is an ISO 8601 timestamp; /note
that this is returned as a string/.
$sel:streamId:StreamSession'
, streamSession_streamId
- Unique identifier for a live or previously live stream in the specified
channel.
$sel:truncatedEvents:StreamSession'
, streamSession_truncatedEvents
- List of Amazon IVS events that the stream encountered. The list is
sorted by most recent events and contains up to 500 events. For Amazon
IVS events, see
Using Amazon EventBridge with Amazon IVS.
streamSession_channel :: Lens' StreamSession (Maybe Channel) Source #
The properties of the channel at the time of going live.
streamSession_endTime :: Lens' StreamSession (Maybe UTCTime) Source #
Time when the channel went offline. This is an ISO 8601 timestamp; /note
that this is returned as a string/. For live streams, this is NULL
.
streamSession_ingestConfiguration :: Lens' StreamSession (Maybe IngestConfiguration) Source #
The properties of the incoming RTMP stream for the stream.
streamSession_recordingConfiguration :: Lens' StreamSession (Maybe RecordingConfiguration) Source #
The properties of recording the live stream.
streamSession_startTime :: Lens' StreamSession (Maybe UTCTime) Source #
Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.
streamSession_streamId :: Lens' StreamSession (Maybe Text) Source #
Unique identifier for a live or previously live stream in the specified channel.
streamSession_truncatedEvents :: Lens' StreamSession (Maybe [StreamEvent]) Source #
List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
StreamSessionSummary
data StreamSessionSummary Source #
Summary information about a stream session.
See: newStreamSessionSummary
smart constructor.
StreamSessionSummary' | |
|
Instances
newStreamSessionSummary :: StreamSessionSummary Source #
Create a value of StreamSessionSummary
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:endTime:StreamSessionSummary'
, streamSessionSummary_endTime
- Time when the channel went offline. This is an ISO 8601 timestamp; /note
that this is returned as a string/. For live streams, this is NULL
.
$sel:hasErrorEvent:StreamSessionSummary'
, streamSessionSummary_hasErrorEvent
- If true
, this stream encountered a quota breach or failure.
$sel:startTime:StreamSessionSummary'
, streamSessionSummary_startTime
- Time when the channel went live. This is an ISO 8601 timestamp; /note
that this is returned as a string/.
$sel:streamId:StreamSessionSummary'
, streamSessionSummary_streamId
- Unique identifier for a live or previously live stream in the specified
channel.
streamSessionSummary_endTime :: Lens' StreamSessionSummary (Maybe UTCTime) Source #
Time when the channel went offline. This is an ISO 8601 timestamp; /note
that this is returned as a string/. For live streams, this is NULL
.
streamSessionSummary_hasErrorEvent :: Lens' StreamSessionSummary (Maybe Bool) Source #
If true
, this stream encountered a quota breach or failure.
streamSessionSummary_startTime :: Lens' StreamSessionSummary (Maybe UTCTime) Source #
Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.
streamSessionSummary_streamId :: Lens' StreamSessionSummary (Maybe Text) Source #
Unique identifier for a live or previously live stream in the specified channel.
StreamSummary
data StreamSummary Source #
Summary information about a stream.
See: newStreamSummary
smart constructor.
StreamSummary' | |
|
Instances
newStreamSummary :: StreamSummary Source #
Create a value of StreamSummary
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:channelArn:StreamSummary'
, streamSummary_channelArn
- Channel ARN for the stream.
$sel:health:StreamSummary'
, streamSummary_health
- The stream’s health.
$sel:startTime:StreamSummary'
, streamSummary_startTime
- Time of the stream’s start. This is an ISO 8601 timestamp; /note that
this is returned as a string/.
$sel:state:StreamSummary'
, streamSummary_state
- The stream’s state.
$sel:streamId:StreamSummary'
, streamSummary_streamId
- Unique identifier for a live or previously live stream in the specified
channel.
$sel:viewerCount:StreamSummary'
, streamSummary_viewerCount
- A count of concurrent views of the stream. Typically, a new view appears
in viewerCount
within 15 seconds of when video playback starts and a
view is removed from viewerCount
within 1 minute of when video
playback ends. A value of -1 indicates that the request timed out; in
this case, retry.
streamSummary_channelArn :: Lens' StreamSummary (Maybe Text) Source #
Channel ARN for the stream.
streamSummary_health :: Lens' StreamSummary (Maybe StreamHealth) Source #
The stream’s health.
streamSummary_startTime :: Lens' StreamSummary (Maybe UTCTime) Source #
Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.
streamSummary_state :: Lens' StreamSummary (Maybe StreamState) Source #
The stream’s state.
streamSummary_streamId :: Lens' StreamSummary (Maybe Text) Source #
Unique identifier for a live or previously live stream in the specified channel.
streamSummary_viewerCount :: Lens' StreamSummary (Maybe Integer) Source #
A count of concurrent views of the stream. Typically, a new view appears
in viewerCount
within 15 seconds of when video playback starts and a
view is removed from viewerCount
within 1 minute of when video
playback ends. A value of -1 indicates that the request timed out; in
this case, retry.
ThumbnailConfiguration
data ThumbnailConfiguration Source #
An object representing a configuration of thumbnails for recorded video.
See: newThumbnailConfiguration
smart constructor.
ThumbnailConfiguration' | |
|
Instances
newThumbnailConfiguration :: ThumbnailConfiguration Source #
Create a value of ThumbnailConfiguration
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:recordingMode:ThumbnailConfiguration'
, thumbnailConfiguration_recordingMode
- Thumbnail recording mode. Default: INTERVAL
.
$sel:targetIntervalSeconds:ThumbnailConfiguration'
, thumbnailConfiguration_targetIntervalSeconds
- The targeted thumbnail-generation interval in seconds. This is
configurable (and required) only if recordingMode
is INTERVAL
.
Default: 60.
Important: Setting a value for targetIntervalSeconds
does not
guarantee that thumbnails are generated at the specified interval. For
thumbnails to be generated at the targetIntervalSeconds
interval, the
IDR/Keyframe
value for the input video must be less than the
targetIntervalSeconds
value. See
Amazon IVS Streaming Configuration
for information on setting IDR/Keyframe
to the recommended value in
video-encoder settings.
thumbnailConfiguration_recordingMode :: Lens' ThumbnailConfiguration (Maybe RecordingMode) Source #
Thumbnail recording mode. Default: INTERVAL
.
thumbnailConfiguration_targetIntervalSeconds :: Lens' ThumbnailConfiguration (Maybe Natural) Source #
The targeted thumbnail-generation interval in seconds. This is
configurable (and required) only if recordingMode
is INTERVAL
.
Default: 60.
Important: Setting a value for targetIntervalSeconds
does not
guarantee that thumbnails are generated at the specified interval. For
thumbnails to be generated at the targetIntervalSeconds
interval, the
IDR/Keyframe
value for the input video must be less than the
targetIntervalSeconds
value. See
Amazon IVS Streaming Configuration
for information on setting IDR/Keyframe
to the recommended value in
video-encoder settings.
VideoConfiguration
data VideoConfiguration Source #
Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.
See: newVideoConfiguration
smart constructor.
VideoConfiguration' | |
|
Instances
newVideoConfiguration :: VideoConfiguration Source #
Create a value of VideoConfiguration
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:avcLevel:VideoConfiguration'
, videoConfiguration_avcLevel
- Indicates the degree of required decoder performance for a profile.
Normally this is set automatically by the encoder. For details, see the
H.264 specification.
$sel:avcProfile:VideoConfiguration'
, videoConfiguration_avcProfile
- Indicates to the decoder the requirements for decoding the stream. For
definitions of the valid values, see the H.264 specification.
$sel:codec:VideoConfiguration'
, videoConfiguration_codec
- Codec used for the video encoding.
$sel:encoder:VideoConfiguration'
, videoConfiguration_encoder
- Software or hardware used to encode the video.
$sel:targetBitrate:VideoConfiguration'
, videoConfiguration_targetBitrate
- The expected ingest bitrate (bits per second). This is configured in the
encoder.
$sel:targetFramerate:VideoConfiguration'
, videoConfiguration_targetFramerate
- The expected ingest framerate. This is configured in the encoder.
$sel:videoHeight:VideoConfiguration'
, videoConfiguration_videoHeight
- Video-resolution height in pixels.
$sel:videoWidth:VideoConfiguration'
, videoConfiguration_videoWidth
- Video-resolution width in pixels.
videoConfiguration_avcLevel :: Lens' VideoConfiguration (Maybe Text) Source #
Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
videoConfiguration_avcProfile :: Lens' VideoConfiguration (Maybe Text) Source #
Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
videoConfiguration_codec :: Lens' VideoConfiguration (Maybe Text) Source #
Codec used for the video encoding.
videoConfiguration_encoder :: Lens' VideoConfiguration (Maybe Text) Source #
Software or hardware used to encode the video.
videoConfiguration_targetBitrate :: Lens' VideoConfiguration (Maybe Integer) Source #
The expected ingest bitrate (bits per second). This is configured in the encoder.
videoConfiguration_targetFramerate :: Lens' VideoConfiguration (Maybe Integer) Source #
The expected ingest framerate. This is configured in the encoder.
videoConfiguration_videoHeight :: Lens' VideoConfiguration (Maybe Integer) Source #
Video-resolution height in pixels.
videoConfiguration_videoWidth :: Lens' VideoConfiguration (Maybe Integer) Source #
Video-resolution width in pixels.