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
- Waiters
- Operations
- BatchGetChannel
- BatchGetStreamKey
- CreateChannel
- CreateRecordingConfiguration
- CreateStreamKey
- DeleteChannel
- DeletePlaybackKeyPair
- DeleteRecordingConfiguration
- DeleteStreamKey
- GetChannel
- GetPlaybackKeyPair
- GetRecordingConfiguration
- GetStream
- GetStreamKey
- GetStreamSession
- ImportPlaybackKeyPair
- ListChannels (Paginated)
- ListPlaybackKeyPairs (Paginated)
- ListRecordingConfigurations (Paginated)
- ListStreamKeys (Paginated)
- ListStreamSessions
- ListStreams (Paginated)
- ListTagsForResource
- PutMetadata
- StopStream
- TagResource
- UntagResource
- UpdateChannel
- Types
- 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
Derived from API version 2020-07-14
of the AWS service descriptions, licensed under Apache 2.0.
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Allowed Header Values
Accept:
Accept-Encoding:
Content-Type:
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
- Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.
- Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. /__Treat the stream key like a secret, since it allows anyone to stream to the channel.__/
- Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.
- Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.
Tagging
A tag is a metadata label that you assign to an Amazon Web Services
resource. A tag comprises a key and a value, both set by you. For
example, you might set a tag as topic:nature
to label a particular
video category. 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.
Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.
At most 50 tags can be applied to a resource.
Authentication versus Authorization
Note the differences between these concepts:
- Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
- Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for "playback authorization.")
Authentication
All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
You generate a signature using valid Amazon Web Services credentials
that have permission to perform the requested action. For example, you
must sign PutMetadata requests with a signature generated from an IAM
user account that has the ivs:PutMetadata
permission.
For more information:
- Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
- Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Channel Endpoints
- CreateChannel — Creates a new channel and an associated stream key to start streaming.
- GetChannel — Gets the channel configuration for the specified channel ARN.
- BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
- ListChannels — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).
- UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
- DeleteChannel — Deletes the specified channel.
StreamKey Endpoints
- CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.
- GetStreamKey — Gets stream key information for the specified ARN.
- BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
- ListStreamKeys — Gets summary information about stream keys for the specified channel.
- DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Stream Endpoints
- GetStream — Gets information about the active (live) stream on a specified channel.
- GetStreamSession — Gets metadata on a specified stream.
- ListStreams — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
- ListStreamSessions — Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
- StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
- PutMetadata — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.
PlaybackKeyPair Endpoints
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
- ImportPlaybackKeyPair — Imports the public portion of a new key pair
and returns its
arn
andfingerprint
. TheprivateKey
can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization). - GetPlaybackKeyPair — Gets a specified playback authorization key
pair and returns the
arn
andfingerprint
. TheprivateKey
held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. - ListPlaybackKeyPairs — Gets summary information about playback key pairs.
- DeletePlaybackKeyPair — Deletes a specified authorization key pair.
This invalidates future viewer tokens generated using the key pair’s
privateKey
.
RecordingConfiguration Endpoints
- CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.
- GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.
- ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
- DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
Amazon Web Services Tags Endpoints
- TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN.
- UntagResource — Removes tags from the resource with the specified ARN.
- ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
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
- data BatchGetChannel = BatchGetChannel' (NonEmpty Text)
- newBatchGetChannel :: NonEmpty Text -> BatchGetChannel
- data BatchGetChannelResponse = BatchGetChannelResponse' (Maybe [Channel]) (Maybe [BatchError]) Int
- newBatchGetChannelResponse :: Int -> BatchGetChannelResponse
- data BatchGetStreamKey = BatchGetStreamKey' (NonEmpty Text)
- newBatchGetStreamKey :: NonEmpty Text -> BatchGetStreamKey
- data BatchGetStreamKeyResponse = BatchGetStreamKeyResponse' (Maybe [BatchError]) (Maybe [StreamKey]) Int
- newBatchGetStreamKeyResponse :: Int -> BatchGetStreamKeyResponse
- data CreateChannel = CreateChannel' (Maybe Bool) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ChannelType)
- newCreateChannel :: CreateChannel
- data CreateChannelResponse = CreateChannelResponse' (Maybe Channel) (Maybe StreamKey) Int
- newCreateChannelResponse :: Int -> CreateChannelResponse
- data CreateRecordingConfiguration = CreateRecordingConfiguration' (Maybe Text) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe ThumbnailConfiguration) DestinationConfiguration
- newCreateRecordingConfiguration :: DestinationConfiguration -> CreateRecordingConfiguration
- data CreateRecordingConfigurationResponse = CreateRecordingConfigurationResponse' (Maybe RecordingConfiguration) Int
- newCreateRecordingConfigurationResponse :: Int -> CreateRecordingConfigurationResponse
- data CreateStreamKey = CreateStreamKey' (Maybe (HashMap Text Text)) Text
- newCreateStreamKey :: Text -> CreateStreamKey
- data CreateStreamKeyResponse = CreateStreamKeyResponse' (Maybe StreamKey) Int
- newCreateStreamKeyResponse :: Int -> CreateStreamKeyResponse
- data DeleteChannel = DeleteChannel' Text
- newDeleteChannel :: Text -> DeleteChannel
- data DeleteChannelResponse = DeleteChannelResponse' {
- newDeleteChannelResponse :: DeleteChannelResponse
- data DeletePlaybackKeyPair = DeletePlaybackKeyPair' Text
- newDeletePlaybackKeyPair :: Text -> DeletePlaybackKeyPair
- data DeletePlaybackKeyPairResponse = DeletePlaybackKeyPairResponse' Int
- newDeletePlaybackKeyPairResponse :: Int -> DeletePlaybackKeyPairResponse
- data DeleteRecordingConfiguration = DeleteRecordingConfiguration' Text
- newDeleteRecordingConfiguration :: Text -> DeleteRecordingConfiguration
- data DeleteRecordingConfigurationResponse = DeleteRecordingConfigurationResponse' {
- newDeleteRecordingConfigurationResponse :: DeleteRecordingConfigurationResponse
- data DeleteStreamKey = DeleteStreamKey' Text
- newDeleteStreamKey :: Text -> DeleteStreamKey
- data DeleteStreamKeyResponse = DeleteStreamKeyResponse' {
- newDeleteStreamKeyResponse :: DeleteStreamKeyResponse
- data GetChannel = GetChannel' Text
- newGetChannel :: Text -> GetChannel
- data GetChannelResponse = GetChannelResponse' (Maybe Channel) Int
- newGetChannelResponse :: Int -> GetChannelResponse
- data GetPlaybackKeyPair = GetPlaybackKeyPair' Text
- newGetPlaybackKeyPair :: Text -> GetPlaybackKeyPair
- data GetPlaybackKeyPairResponse = GetPlaybackKeyPairResponse' (Maybe PlaybackKeyPair) Int
- newGetPlaybackKeyPairResponse :: Int -> GetPlaybackKeyPairResponse
- data GetRecordingConfiguration = GetRecordingConfiguration' Text
- newGetRecordingConfiguration :: Text -> GetRecordingConfiguration
- data GetRecordingConfigurationResponse = GetRecordingConfigurationResponse' (Maybe RecordingConfiguration) Int
- newGetRecordingConfigurationResponse :: Int -> GetRecordingConfigurationResponse
- data GetStream = GetStream' Text
- newGetStream :: Text -> GetStream
- data GetStreamResponse = GetStreamResponse' (Maybe Stream) Int
- newGetStreamResponse :: Int -> GetStreamResponse
- data GetStreamKey = GetStreamKey' Text
- newGetStreamKey :: Text -> GetStreamKey
- data GetStreamKeyResponse = GetStreamKeyResponse' (Maybe StreamKey) Int
- newGetStreamKeyResponse :: Int -> GetStreamKeyResponse
- data GetStreamSession = GetStreamSession' (Maybe Text) Text
- newGetStreamSession :: Text -> GetStreamSession
- data GetStreamSessionResponse = GetStreamSessionResponse' (Maybe StreamSession) Int
- newGetStreamSessionResponse :: Int -> GetStreamSessionResponse
- data ImportPlaybackKeyPair = ImportPlaybackKeyPair' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newImportPlaybackKeyPair :: Text -> ImportPlaybackKeyPair
- data ImportPlaybackKeyPairResponse = ImportPlaybackKeyPairResponse' (Maybe PlaybackKeyPair) Int
- newImportPlaybackKeyPairResponse :: Int -> ImportPlaybackKeyPairResponse
- data ListChannels = ListChannels' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)
- newListChannels :: ListChannels
- data ListChannelsResponse = ListChannelsResponse' (Maybe Text) Int [ChannelSummary]
- newListChannelsResponse :: Int -> ListChannelsResponse
- data ListPlaybackKeyPairs = ListPlaybackKeyPairs' (Maybe Natural) (Maybe Text)
- newListPlaybackKeyPairs :: ListPlaybackKeyPairs
- data ListPlaybackKeyPairsResponse = ListPlaybackKeyPairsResponse' (Maybe Text) Int [PlaybackKeyPairSummary]
- newListPlaybackKeyPairsResponse :: Int -> ListPlaybackKeyPairsResponse
- data ListRecordingConfigurations = ListRecordingConfigurations' (Maybe Natural) (Maybe Text)
- newListRecordingConfigurations :: ListRecordingConfigurations
- data ListRecordingConfigurationsResponse = ListRecordingConfigurationsResponse' (Maybe Text) Int [RecordingConfigurationSummary]
- newListRecordingConfigurationsResponse :: Int -> ListRecordingConfigurationsResponse
- data ListStreamKeys = ListStreamKeys' (Maybe Natural) (Maybe Text) Text
- newListStreamKeys :: Text -> ListStreamKeys
- data ListStreamKeysResponse = ListStreamKeysResponse' (Maybe Text) Int [StreamKeySummary]
- newListStreamKeysResponse :: Int -> ListStreamKeysResponse
- data ListStreamSessions = ListStreamSessions' (Maybe Natural) (Maybe Text) Text
- newListStreamSessions :: Text -> ListStreamSessions
- data ListStreamSessionsResponse = ListStreamSessionsResponse' (Maybe Text) Int [StreamSessionSummary]
- newListStreamSessionsResponse :: Int -> ListStreamSessionsResponse
- data ListStreams = ListStreams' (Maybe StreamFilters) (Maybe Natural) (Maybe Text)
- newListStreams :: ListStreams
- data ListStreamsResponse = ListStreamsResponse' (Maybe Text) Int [StreamSummary]
- newListStreamsResponse :: Int -> ListStreamsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' Int (HashMap Text Text)
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutMetadata = PutMetadata' Text (Sensitive Text)
- newPutMetadata :: Text -> Text -> PutMetadata
- data PutMetadataResponse = PutMetadataResponse' {
- newPutMetadataResponse :: PutMetadataResponse
- data StopStream = StopStream' Text
- newStopStream :: Text -> StopStream
- data StopStreamResponse = StopStreamResponse' Int
- newStopStreamResponse :: Int -> StopStreamResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateChannel = UpdateChannel' (Maybe Bool) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe ChannelType) Text
- newUpdateChannel :: Text -> UpdateChannel
- data UpdateChannelResponse = UpdateChannelResponse' (Maybe Channel) Int
- newUpdateChannelResponse :: Int -> UpdateChannelResponse
- 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' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Integer)
- newAudioConfiguration :: AudioConfiguration
- data BatchError = BatchError' (Maybe Text) (Maybe Text) (Maybe Text)
- newBatchError :: BatchError
- data Channel = Channel' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ChannelType)
- newChannel :: Channel
- data ChannelSummary = ChannelSummary' (Maybe Text) (Maybe Bool) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text))
- newChannelSummary :: ChannelSummary
- data DestinationConfiguration = DestinationConfiguration' (Maybe S3DestinationConfiguration)
- newDestinationConfiguration :: DestinationConfiguration
- data IngestConfiguration = IngestConfiguration' (Maybe AudioConfiguration) (Maybe VideoConfiguration)
- newIngestConfiguration :: IngestConfiguration
- data PlaybackKeyPair = PlaybackKeyPair' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text))
- newPlaybackKeyPair :: PlaybackKeyPair
- data PlaybackKeyPairSummary = PlaybackKeyPairSummary' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text))
- newPlaybackKeyPairSummary :: PlaybackKeyPairSummary
- data RecordingConfiguration = RecordingConfiguration' (Maybe Text) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe ThumbnailConfiguration) Text DestinationConfiguration RecordingConfigurationState
- newRecordingConfiguration :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfiguration
- data RecordingConfigurationSummary = RecordingConfigurationSummary' (Maybe Text) (Maybe (HashMap Text Text)) Text DestinationConfiguration RecordingConfigurationState
- newRecordingConfigurationSummary :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfigurationSummary
- data S3DestinationConfiguration = S3DestinationConfiguration' Text
- newS3DestinationConfiguration :: Text -> S3DestinationConfiguration
- data Stream = Stream' (Maybe Text) (Maybe StreamHealth) (Maybe Text) (Maybe ISO8601) (Maybe StreamState) (Maybe Text) (Maybe Integer)
- newStream :: Stream
- data StreamEvent = StreamEvent' (Maybe ISO8601) (Maybe Text) (Maybe Text)
- newStreamEvent :: StreamEvent
- data StreamFilters = StreamFilters' (Maybe StreamHealth)
- newStreamFilters :: StreamFilters
- data StreamKey = StreamKey' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (Sensitive Text))
- newStreamKey :: StreamKey
- data StreamKeySummary = StreamKeySummary' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text))
- newStreamKeySummary :: StreamKeySummary
- data StreamSession = StreamSession' (Maybe Channel) (Maybe ISO8601) (Maybe IngestConfiguration) (Maybe RecordingConfiguration) (Maybe ISO8601) (Maybe Text) (Maybe [StreamEvent])
- newStreamSession :: StreamSession
- data StreamSessionSummary = StreamSessionSummary' (Maybe ISO8601) (Maybe Bool) (Maybe ISO8601) (Maybe Text)
- newStreamSessionSummary :: StreamSessionSummary
- data StreamSummary = StreamSummary' (Maybe Text) (Maybe StreamHealth) (Maybe ISO8601) (Maybe StreamState) (Maybe Text) (Maybe Integer)
- newStreamSummary :: StreamSummary
- data ThumbnailConfiguration = ThumbnailConfiguration' (Maybe RecordingMode) (Maybe Natural)
- newThumbnailConfiguration :: ThumbnailConfiguration
- data VideoConfiguration = VideoConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newVideoConfiguration :: VideoConfiguration
Service Configuration
defaultService :: Service Source #
API version 2020-07-14
of the Amazon Interactive Video Service 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 IVS
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
ChannelNotBroadcasting
_ChannelNotBroadcasting :: AsError a => Fold a ServiceError Source #
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
PendingVerification
_PendingVerification :: AsError a => Fold a ServiceError Source #
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
StreamUnavailable
_StreamUnavailable :: AsError a => Fold a ServiceError Source #
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
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.
BatchGetChannel
data BatchGetChannel Source #
See: newBatchGetChannel
smart constructor.
Instances
Create a value of BatchGetChannel
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:arns:BatchGetChannel'
, batchGetChannel_arns
- Array of ARNs, one per channel.
data BatchGetChannelResponse Source #
See: newBatchGetChannelResponse
smart constructor.
Instances
newBatchGetChannelResponse Source #
Create a value of BatchGetChannelResponse
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:
BatchGetChannelResponse
, batchGetChannelResponse_channels
-
$sel:errors:BatchGetChannelResponse'
, batchGetChannelResponse_errors
- Each error object is related to a specific ARN in the request.
$sel:httpStatus:BatchGetChannelResponse'
, batchGetChannelResponse_httpStatus
- The response's http status code.
BatchGetStreamKey
data BatchGetStreamKey Source #
See: newBatchGetStreamKey
smart constructor.
Instances
Create a value of BatchGetStreamKey
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:arns:BatchGetStreamKey'
, batchGetStreamKey_arns
- Array of ARNs, one per channel.
data BatchGetStreamKeyResponse Source #
See: newBatchGetStreamKeyResponse
smart constructor.
Instances
newBatchGetStreamKeyResponse Source #
Create a value of BatchGetStreamKeyResponse
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:errors:BatchGetStreamKeyResponse'
, batchGetStreamKeyResponse_errors
-
$sel:streamKeys:BatchGetStreamKeyResponse'
, batchGetStreamKeyResponse_streamKeys
-
$sel:httpStatus:BatchGetStreamKeyResponse'
, batchGetStreamKeyResponse_httpStatus
- The response's http status code.
CreateChannel
data CreateChannel Source #
See: newCreateChannel
smart constructor.
CreateChannel' (Maybe Bool) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ChannelType) |
Instances
newCreateChannel :: CreateChannel Source #
Create a value of CreateChannel
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:
CreateChannel
, createChannel_authorized
- Whether the channel is private (enabled for playback authorization).
Default: false
.
CreateChannel
, createChannel_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.
(Note: In the Amazon IVS console, LOW
and NORMAL
correspond to
Ultra-low and Standard, respectively.) Default: LOW
.
CreateChannel
, createChannel_name
- Channel name.
CreateChannel
, createChannel_recordingConfigurationArn
- Recording-configuration ARN. Default: "" (empty string, recording is
disabled).
CreateChannel
, createChannel_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.
CreateChannel
, createChannel_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.
data CreateChannelResponse Source #
See: newCreateChannelResponse
smart constructor.
Instances
newCreateChannelResponse Source #
Create a value of CreateChannelResponse
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:
CreateChannelResponse
, createChannelResponse_channel
-
$sel:streamKey:CreateChannelResponse'
, createChannelResponse_streamKey
-
$sel:httpStatus:CreateChannelResponse'
, createChannelResponse_httpStatus
- The response's http status code.
CreateRecordingConfiguration
data CreateRecordingConfiguration Source #
See: newCreateRecordingConfiguration
smart constructor.
CreateRecordingConfiguration' (Maybe Text) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe ThumbnailConfiguration) DestinationConfiguration |
Instances
newCreateRecordingConfiguration Source #
Create a value of CreateRecordingConfiguration
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:
CreateRecordingConfiguration
, createRecordingConfiguration_name
- Recording-configuration name. The value does not need to be unique.
CreateRecordingConfiguration
, createRecordingConfiguration_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.
CreateRecordingConfiguration
, createRecordingConfiguration_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.
CreateRecordingConfiguration
, createRecordingConfiguration_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.
CreateRecordingConfiguration
, createRecordingConfiguration_destinationConfiguration
- A complex type that contains a destination configuration for where
recorded video will be stored.
data CreateRecordingConfigurationResponse Source #
See: newCreateRecordingConfigurationResponse
smart constructor.
Instances
Generic CreateRecordingConfigurationResponse Source # | |
Read CreateRecordingConfigurationResponse Source # | |
Show CreateRecordingConfigurationResponse Source # | |
NFData CreateRecordingConfigurationResponse Source # | |
Defined in Amazonka.IVS.CreateRecordingConfiguration rnf :: CreateRecordingConfigurationResponse -> () # | |
Eq CreateRecordingConfigurationResponse Source # | |
type Rep CreateRecordingConfigurationResponse Source # | |
Defined in Amazonka.IVS.CreateRecordingConfiguration type Rep CreateRecordingConfigurationResponse = D1 ('MetaData "CreateRecordingConfigurationResponse" "Amazonka.IVS.CreateRecordingConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "CreateRecordingConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recordingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecordingConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateRecordingConfigurationResponse Source #
Create a value of CreateRecordingConfigurationResponse
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:
CreateRecordingConfigurationResponse
, createRecordingConfigurationResponse_recordingConfiguration
-
$sel:httpStatus:CreateRecordingConfigurationResponse'
, createRecordingConfigurationResponse_httpStatus
- The response's http status code.
CreateStreamKey
data CreateStreamKey Source #
See: newCreateStreamKey
smart constructor.
Instances
Create a value of CreateStreamKey
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:
CreateStreamKey
, createStreamKey_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.
CreateStreamKey
, createStreamKey_channelArn
- ARN of the channel for which to create the stream key.
data CreateStreamKeyResponse Source #
See: newCreateStreamKeyResponse
smart constructor.
Instances
newCreateStreamKeyResponse Source #
Create a value of CreateStreamKeyResponse
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:streamKey:CreateStreamKeyResponse'
, createStreamKeyResponse_streamKey
- Stream key used to authenticate an RTMPS stream for ingestion.
$sel:httpStatus:CreateStreamKeyResponse'
, createStreamKeyResponse_httpStatus
- The response's http status code.
DeleteChannel
data DeleteChannel Source #
See: newDeleteChannel
smart constructor.
Instances
Create a value of DeleteChannel
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:
DeleteChannel
, deleteChannel_arn
- ARN of the channel to be deleted.
data DeleteChannelResponse Source #
See: newDeleteChannelResponse
smart constructor.
Instances
Generic DeleteChannelResponse Source # | |
Defined in Amazonka.IVS.DeleteChannel type Rep DeleteChannelResponse :: Type -> Type # | |
Read DeleteChannelResponse Source # | |
Show DeleteChannelResponse Source # | |
Defined in Amazonka.IVS.DeleteChannel showsPrec :: Int -> DeleteChannelResponse -> ShowS # show :: DeleteChannelResponse -> String # showList :: [DeleteChannelResponse] -> ShowS # | |
NFData DeleteChannelResponse Source # | |
Defined in Amazonka.IVS.DeleteChannel rnf :: DeleteChannelResponse -> () # | |
Eq DeleteChannelResponse Source # | |
Defined in Amazonka.IVS.DeleteChannel (==) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool # (/=) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool # | |
type Rep DeleteChannelResponse Source # | |
newDeleteChannelResponse :: DeleteChannelResponse Source #
Create a value of DeleteChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePlaybackKeyPair
data DeletePlaybackKeyPair Source #
See: newDeletePlaybackKeyPair
smart constructor.
Instances
newDeletePlaybackKeyPair Source #
Create a value of DeletePlaybackKeyPair
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:
DeletePlaybackKeyPair
, deletePlaybackKeyPair_arn
- ARN of the key pair to be deleted.
data DeletePlaybackKeyPairResponse Source #
See: newDeletePlaybackKeyPairResponse
smart constructor.
Instances
newDeletePlaybackKeyPairResponse Source #
Create a value of DeletePlaybackKeyPairResponse
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:httpStatus:DeletePlaybackKeyPairResponse'
, deletePlaybackKeyPairResponse_httpStatus
- The response's http status code.
DeleteRecordingConfiguration
data DeleteRecordingConfiguration Source #
See: newDeleteRecordingConfiguration
smart constructor.
Instances
newDeleteRecordingConfiguration Source #
Create a value of DeleteRecordingConfiguration
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:
DeleteRecordingConfiguration
, deleteRecordingConfiguration_arn
- ARN of the recording configuration to be deleted.
data DeleteRecordingConfigurationResponse Source #
See: newDeleteRecordingConfigurationResponse
smart constructor.
Instances
newDeleteRecordingConfigurationResponse :: DeleteRecordingConfigurationResponse Source #
Create a value of DeleteRecordingConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteStreamKey
data DeleteStreamKey Source #
See: newDeleteStreamKey
smart constructor.
Instances
Create a value of DeleteStreamKey
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:
DeleteStreamKey
, deleteStreamKey_arn
- ARN of the stream key to be deleted.
data DeleteStreamKeyResponse Source #
See: newDeleteStreamKeyResponse
smart constructor.
Instances
Generic DeleteStreamKeyResponse Source # | |
Defined in Amazonka.IVS.DeleteStreamKey type Rep DeleteStreamKeyResponse :: Type -> Type # | |
Read DeleteStreamKeyResponse Source # | |
Show DeleteStreamKeyResponse Source # | |
Defined in Amazonka.IVS.DeleteStreamKey showsPrec :: Int -> DeleteStreamKeyResponse -> ShowS # show :: DeleteStreamKeyResponse -> String # showList :: [DeleteStreamKeyResponse] -> ShowS # | |
NFData DeleteStreamKeyResponse Source # | |
Defined in Amazonka.IVS.DeleteStreamKey rnf :: DeleteStreamKeyResponse -> () # | |
Eq DeleteStreamKeyResponse Source # | |
Defined in Amazonka.IVS.DeleteStreamKey | |
type Rep DeleteStreamKeyResponse Source # | |
newDeleteStreamKeyResponse :: DeleteStreamKeyResponse Source #
Create a value of DeleteStreamKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetChannel
data GetChannel Source #
See: newGetChannel
smart constructor.
Instances
:: Text | |
-> GetChannel |
Create a value of GetChannel
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:
GetChannel
, getChannel_arn
- ARN of the channel for which the configuration is to be retrieved.
data GetChannelResponse Source #
See: newGetChannelResponse
smart constructor.
Instances
newGetChannelResponse Source #
Create a value of GetChannelResponse
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:
GetChannelResponse
, getChannelResponse_channel
-
$sel:httpStatus:GetChannelResponse'
, getChannelResponse_httpStatus
- The response's http status code.
GetPlaybackKeyPair
data GetPlaybackKeyPair Source #
See: newGetPlaybackKeyPair
smart constructor.
Instances
newGetPlaybackKeyPair Source #
Create a value of GetPlaybackKeyPair
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:
GetPlaybackKeyPair
, getPlaybackKeyPair_arn
- ARN of the key pair to be returned.
data GetPlaybackKeyPairResponse Source #
See: newGetPlaybackKeyPairResponse
smart constructor.
Instances
newGetPlaybackKeyPairResponse Source #
Create a value of GetPlaybackKeyPairResponse
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:keyPair:GetPlaybackKeyPairResponse'
, getPlaybackKeyPairResponse_keyPair
-
$sel:httpStatus:GetPlaybackKeyPairResponse'
, getPlaybackKeyPairResponse_httpStatus
- The response's http status code.
GetRecordingConfiguration
data GetRecordingConfiguration Source #
See: newGetRecordingConfiguration
smart constructor.
Instances
newGetRecordingConfiguration Source #
Create a value of GetRecordingConfiguration
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:
GetRecordingConfiguration
, getRecordingConfiguration_arn
- ARN of the recording configuration to be retrieved.
data GetRecordingConfigurationResponse Source #
See: newGetRecordingConfigurationResponse
smart constructor.
Instances
Generic GetRecordingConfigurationResponse Source # | |
Read GetRecordingConfigurationResponse Source # | |
Show GetRecordingConfigurationResponse Source # | |
Defined in Amazonka.IVS.GetRecordingConfiguration | |
NFData GetRecordingConfigurationResponse Source # | |
Defined in Amazonka.IVS.GetRecordingConfiguration rnf :: GetRecordingConfigurationResponse -> () # | |
Eq GetRecordingConfigurationResponse Source # | |
type Rep GetRecordingConfigurationResponse Source # | |
Defined in Amazonka.IVS.GetRecordingConfiguration type Rep GetRecordingConfigurationResponse = D1 ('MetaData "GetRecordingConfigurationResponse" "Amazonka.IVS.GetRecordingConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "GetRecordingConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recordingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecordingConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetRecordingConfigurationResponse Source #
Create a value of GetRecordingConfigurationResponse
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:
GetRecordingConfigurationResponse
, getRecordingConfigurationResponse_recordingConfiguration
-
$sel:httpStatus:GetRecordingConfigurationResponse'
, getRecordingConfigurationResponse_httpStatus
- The response's http status code.
GetStream
See: newGetStream
smart constructor.
Instances
Create a value of GetStream
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:
GetStream
, getStream_channelArn
- Channel ARN for stream to be accessed.
data GetStreamResponse Source #
See: newGetStreamResponse
smart constructor.
Instances
Create a value of GetStreamResponse
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:stream:GetStreamResponse'
, getStreamResponse_stream
-
$sel:httpStatus:GetStreamResponse'
, getStreamResponse_httpStatus
- The response's http status code.
GetStreamKey
data GetStreamKey Source #
See: newGetStreamKey
smart constructor.
Instances
Create a value of GetStreamKey
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:
GetStreamKey
, getStreamKey_arn
- ARN for the stream key to be retrieved.
data GetStreamKeyResponse Source #
See: newGetStreamKeyResponse
smart constructor.
Instances
newGetStreamKeyResponse Source #
Create a value of GetStreamKeyResponse
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:streamKey:GetStreamKeyResponse'
, getStreamKeyResponse_streamKey
-
$sel:httpStatus:GetStreamKeyResponse'
, getStreamKeyResponse_httpStatus
- The response's http status code.
GetStreamSession
data GetStreamSession Source #
See: newGetStreamSession
smart constructor.
Instances
Create a value of GetStreamSession
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:
GetStreamSession
, getStreamSession_streamId
- Unique identifier for a live or previously live stream in the specified
channel. If no streamId
is provided, this returns the most recent
stream session for the channel, if it exists.
GetStreamSession
, getStreamSession_channelArn
- ARN of the channel resource
data GetStreamSessionResponse Source #
See: newGetStreamSessionResponse
smart constructor.
Instances
newGetStreamSessionResponse Source #
Create a value of GetStreamSessionResponse
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:streamSession:GetStreamSessionResponse'
, getStreamSessionResponse_streamSession
- List of stream details.
$sel:httpStatus:GetStreamSessionResponse'
, getStreamSessionResponse_httpStatus
- The response's http status code.
ImportPlaybackKeyPair
data ImportPlaybackKeyPair Source #
See: newImportPlaybackKeyPair
smart constructor.
Instances
newImportPlaybackKeyPair Source #
Create a value of ImportPlaybackKeyPair
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:
ImportPlaybackKeyPair
, importPlaybackKeyPair_name
- Playback-key-pair name. The value does not need to be unique.
ImportPlaybackKeyPair
, importPlaybackKeyPair_tags
- Any tags provided with the request are added to the playback key pair
tags. 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:publicKeyMaterial:ImportPlaybackKeyPair'
, importPlaybackKeyPair_publicKeyMaterial
- The public portion of a customer-generated key pair.
data ImportPlaybackKeyPairResponse Source #
See: newImportPlaybackKeyPairResponse
smart constructor.
Instances
newImportPlaybackKeyPairResponse Source #
Create a value of ImportPlaybackKeyPairResponse
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:keyPair:ImportPlaybackKeyPairResponse'
, importPlaybackKeyPairResponse_keyPair
-
$sel:httpStatus:ImportPlaybackKeyPairResponse'
, importPlaybackKeyPairResponse_httpStatus
- The response's http status code.
ListChannels (Paginated)
data ListChannels Source #
See: newListChannels
smart constructor.
Instances
newListChannels :: ListChannels Source #
Create a value of ListChannels
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:filterByName:ListChannels'
, listChannels_filterByName
- Filters the channel list to match the specified name.
$sel:filterByRecordingConfigurationArn:ListChannels'
, listChannels_filterByRecordingConfigurationArn
- Filters the channel list to match the specified recording-configuration
ARN.
$sel:maxResults:ListChannels'
, listChannels_maxResults
- Maximum number of channels to return. Default: 100.
ListChannels
, listChannels_nextToken
- The first channel to retrieve. This is used for pagination; see the
nextToken
response field.
data ListChannelsResponse Source #
See: newListChannelsResponse
smart constructor.
Instances
newListChannelsResponse Source #
Create a value of ListChannelsResponse
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:
ListChannels
, listChannelsResponse_nextToken
- If there are more channels than maxResults
, use nextToken
in the
request to get the next set.
$sel:httpStatus:ListChannelsResponse'
, listChannelsResponse_httpStatus
- The response's http status code.
ListChannelsResponse
, listChannelsResponse_channels
- List of the matching channels.
ListPlaybackKeyPairs (Paginated)
data ListPlaybackKeyPairs Source #
See: newListPlaybackKeyPairs
smart constructor.
Instances
newListPlaybackKeyPairs :: ListPlaybackKeyPairs Source #
Create a value of ListPlaybackKeyPairs
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:maxResults:ListPlaybackKeyPairs'
, listPlaybackKeyPairs_maxResults
- Maximum number of key pairs to return. Default: your service quota or
100, whichever is smaller.
ListPlaybackKeyPairs
, listPlaybackKeyPairs_nextToken
- The first key pair to retrieve. This is used for pagination; see the
nextToken
response field.
data ListPlaybackKeyPairsResponse Source #
See: newListPlaybackKeyPairsResponse
smart constructor.
Instances
newListPlaybackKeyPairsResponse Source #
Create a value of ListPlaybackKeyPairsResponse
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:
ListPlaybackKeyPairs
, listPlaybackKeyPairsResponse_nextToken
- If there are more key pairs than maxResults
, use nextToken
in the
request to get the next set.
$sel:httpStatus:ListPlaybackKeyPairsResponse'
, listPlaybackKeyPairsResponse_httpStatus
- The response's http status code.
$sel:keyPairs:ListPlaybackKeyPairsResponse'
, listPlaybackKeyPairsResponse_keyPairs
- List of key pairs.
ListRecordingConfigurations (Paginated)
data ListRecordingConfigurations Source #
See: newListRecordingConfigurations
smart constructor.
Instances
newListRecordingConfigurations :: ListRecordingConfigurations Source #
Create a value of ListRecordingConfigurations
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:maxResults:ListRecordingConfigurations'
, listRecordingConfigurations_maxResults
- Maximum number of recording configurations to return. Default: your
service quota or 100, whichever is smaller.
ListRecordingConfigurations
, listRecordingConfigurations_nextToken
- The first recording configuration to retrieve. This is used for
pagination; see the nextToken
response field.
data ListRecordingConfigurationsResponse Source #
See: newListRecordingConfigurationsResponse
smart constructor.
Instances
newListRecordingConfigurationsResponse Source #
Create a value of ListRecordingConfigurationsResponse
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:
ListRecordingConfigurations
, listRecordingConfigurationsResponse_nextToken
- If there are more recording configurations than maxResults
, use
nextToken
in the request to get the next set.
$sel:httpStatus:ListRecordingConfigurationsResponse'
, listRecordingConfigurationsResponse_httpStatus
- The response's http status code.
$sel:recordingConfigurations:ListRecordingConfigurationsResponse'
, listRecordingConfigurationsResponse_recordingConfigurations
- List of the matching recording configurations.
ListStreamKeys (Paginated)
data ListStreamKeys Source #
See: newListStreamKeys
smart constructor.
Instances
Create a value of ListStreamKeys
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:maxResults:ListStreamKeys'
, listStreamKeys_maxResults
- Maximum number of streamKeys to return. Default: 1.
ListStreamKeys
, listStreamKeys_nextToken
- The first stream key to retrieve. This is used for pagination; see the
nextToken
response field.
ListStreamKeys
, listStreamKeys_channelArn
- Channel ARN used to filter the list.
data ListStreamKeysResponse Source #
See: newListStreamKeysResponse
smart constructor.
Instances
newListStreamKeysResponse Source #
Create a value of ListStreamKeysResponse
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:
ListStreamKeys
, listStreamKeysResponse_nextToken
- If there are more stream keys than maxResults
, use nextToken
in the
request to get the next set.
$sel:httpStatus:ListStreamKeysResponse'
, listStreamKeysResponse_httpStatus
- The response's http status code.
$sel:streamKeys:ListStreamKeysResponse'
, listStreamKeysResponse_streamKeys
- List of stream keys.
ListStreamSessions
data ListStreamSessions Source #
See: newListStreamSessions
smart constructor.
Instances
newListStreamSessions Source #
Create a value of ListStreamSessions
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:maxResults:ListStreamSessions'
, listStreamSessions_maxResults
- Maximum number of streams to return. Default: 100.
ListStreamSessions
, listStreamSessions_nextToken
- The first stream to retrieve. This is used for pagination; see the
nextToken
response field.
ListStreamSessions
, listStreamSessions_channelArn
- Channel ARN used to filter the list.
data ListStreamSessionsResponse Source #
See: newListStreamSessionsResponse
smart constructor.
Instances
newListStreamSessionsResponse Source #
Create a value of ListStreamSessionsResponse
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:
ListStreamSessions
, listStreamSessionsResponse_nextToken
- If there are more streams than maxResults
, use nextToken
in the
request to get the next set.
$sel:httpStatus:ListStreamSessionsResponse'
, listStreamSessionsResponse_httpStatus
- The response's http status code.
$sel:streamSessions:ListStreamSessionsResponse'
, listStreamSessionsResponse_streamSessions
- List of stream sessions.
ListStreams (Paginated)
data ListStreams Source #
See: newListStreams
smart constructor.
Instances
newListStreams :: ListStreams Source #
Create a value of ListStreams
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:filterBy:ListStreams'
, listStreams_filterBy
- Filters the stream list to match the specified criterion.
$sel:maxResults:ListStreams'
, listStreams_maxResults
- Maximum number of streams to return. Default: 100.
ListStreams
, listStreams_nextToken
- The first stream to retrieve. This is used for pagination; see the
nextToken
response field.
data ListStreamsResponse Source #
See: newListStreamsResponse
smart constructor.
Instances
newListStreamsResponse Source #
Create a value of ListStreamsResponse
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:
ListStreams
, listStreamsResponse_nextToken
- If there are more streams than maxResults
, use nextToken
in the
request to get the next set.
$sel:httpStatus:ListStreamsResponse'
, listStreamsResponse_httpStatus
- The response's http status code.
$sel:streams:ListStreamsResponse'
, listStreamsResponse_streams
- List of streams.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The ARN of the resource to be retrieved. The ARN must be URL-encoded.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
-
PutMetadata
data PutMetadata Source #
See: newPutMetadata
smart constructor.
Instances
Create a value of PutMetadata
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:
PutMetadata
, putMetadata_channelArn
- ARN of the channel into which metadata is inserted. This channel must
have an active stream.
$sel:metadata:PutMetadata'
, putMetadata_metadata
- Metadata to insert into the stream. Maximum: 1 KB per request.
data PutMetadataResponse Source #
See: newPutMetadataResponse
smart constructor.
Instances
Generic PutMetadataResponse Source # | |
Defined in Amazonka.IVS.PutMetadata type Rep PutMetadataResponse :: Type -> Type # from :: PutMetadataResponse -> Rep PutMetadataResponse x # to :: Rep PutMetadataResponse x -> PutMetadataResponse # | |
Read PutMetadataResponse Source # | |
Defined in Amazonka.IVS.PutMetadata | |
Show PutMetadataResponse Source # | |
Defined in Amazonka.IVS.PutMetadata showsPrec :: Int -> PutMetadataResponse -> ShowS # show :: PutMetadataResponse -> String # showList :: [PutMetadataResponse] -> ShowS # | |
NFData PutMetadataResponse Source # | |
Defined in Amazonka.IVS.PutMetadata rnf :: PutMetadataResponse -> () # | |
Eq PutMetadataResponse Source # | |
Defined in Amazonka.IVS.PutMetadata (==) :: PutMetadataResponse -> PutMetadataResponse -> Bool # (/=) :: PutMetadataResponse -> PutMetadataResponse -> Bool # | |
type Rep PutMetadataResponse Source # | |
newPutMetadataResponse :: PutMetadataResponse Source #
Create a value of PutMetadataResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopStream
data StopStream Source #
See: newStopStream
smart constructor.
Instances
:: Text | |
-> StopStream |
Create a value of StopStream
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:
StopStream
, stopStream_channelArn
- ARN of the channel for which the stream is to be stopped.
data StopStreamResponse Source #
See: newStopStreamResponse
smart constructor.
Instances
newStopStreamResponse Source #
Create a value of StopStreamResponse
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:httpStatus:StopStreamResponse'
, stopStreamResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- ARN of the resource for which tags are to be added or updated. The ARN
must be URL-encoded.
TagResource
, tagResource_tags
- Array of tags to be added or updated. 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.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- ARN of the resource for which tags are to be removed. The ARN must be
URL-encoded.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- Array of tags to be removed. 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.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateChannel
data UpdateChannel Source #
See: newUpdateChannel
smart constructor.
UpdateChannel' (Maybe Bool) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe ChannelType) Text |
Instances
Create a value of UpdateChannel
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:
UpdateChannel
, updateChannel_authorized
- Whether the channel is private (enabled for playback authorization).
UpdateChannel
, updateChannel_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.
(Note: In the Amazon IVS console, LOW
and NORMAL
correspond to
Ultra-low and Standard, respectively.)
UpdateChannel
, updateChannel_name
- Channel name.
UpdateChannel
, updateChannel_recordingConfigurationArn
- Recording-configuration ARN. If this is set to an empty string,
recording is disabled. A value other than an empty string indicates that
recording is enabled
UpdateChannel
, updateChannel_type
- Channel type, which determines the allowable resolution and bitrate. /If
you exceed the allowable resolution or bitrate, the stream probably will
disconnect immediately/. 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.
UpdateChannel
, updateChannel_arn
- ARN of the channel to be updated.
data UpdateChannelResponse Source #
See: newUpdateChannelResponse
smart constructor.
Instances
newUpdateChannelResponse Source #
Create a value of UpdateChannelResponse
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:
UpdateChannelResponse
, updateChannelResponse_channel
- Undocumented member.
$sel:httpStatus:UpdateChannelResponse'
, updateChannelResponse_httpStatus
- The response's http status code.
Types
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.
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.
Channel
Object specifying a channel.
See: newChannel
smart constructor.
Channel' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ChannelType) |
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.
ChannelSummary
data ChannelSummary Source #
Summary information about a channel.
See: newChannelSummary
smart constructor.
ChannelSummary' (Maybe Text) (Maybe Bool) (Maybe ChannelLatencyMode) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) |
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.
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.
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.
IngestConfiguration
data IngestConfiguration Source #
Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.
See: newIngestConfiguration
smart constructor.
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.
PlaybackKeyPair
data PlaybackKeyPair Source #
A key pair used to sign and validate a playback authorization token.
See: newPlaybackKeyPair
smart constructor.
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.
PlaybackKeyPairSummary
data PlaybackKeyPairSummary Source #
Summary information about a playback key pair.
See: newPlaybackKeyPairSummary
smart constructor.
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.
RecordingConfiguration
data RecordingConfiguration Source #
An object representing a configuration to record a channel stream.
See: newRecordingConfiguration
smart constructor.
RecordingConfiguration' (Maybe Text) (Maybe Natural) (Maybe (HashMap Text Text)) (Maybe ThumbnailConfiguration) Text DestinationConfiguration RecordingConfigurationState |
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.
RecordingConfigurationSummary
data RecordingConfigurationSummary Source #
Summary information about a RecordingConfiguration.
See: newRecordingConfigurationSummary
smart constructor.
RecordingConfigurationSummary' (Maybe Text) (Maybe (HashMap Text Text)) Text DestinationConfiguration RecordingConfigurationState |
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.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
A complex type that describes an S3 location where recorded videos will be stored.
See: newS3DestinationConfiguration
smart constructor.
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.
Stream
Specifies a live video stream that has been ingested and distributed.
See: newStream
smart constructor.
Stream' (Maybe Text) (Maybe StreamHealth) (Maybe Text) (Maybe ISO8601) (Maybe StreamState) (Maybe Text) (Maybe Integer) |
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.
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.
StreamFilters
data StreamFilters Source #
Object specifying the stream attribute on which to filter.
See: newStreamFilters
smart constructor.
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.
StreamKey
Object specifying a stream key.
See: newStreamKey
smart constructor.
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.
StreamKeySummary
data StreamKeySummary Source #
Summary information about a stream key.
See: newStreamKeySummary
smart constructor.
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.
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' (Maybe Channel) (Maybe ISO8601) (Maybe IngestConfiguration) (Maybe RecordingConfiguration) (Maybe ISO8601) (Maybe Text) (Maybe [StreamEvent]) |
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.
StreamSessionSummary
data StreamSessionSummary Source #
Summary information about a stream session.
See: newStreamSessionSummary
smart constructor.
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.
StreamSummary
data StreamSummary Source #
Summary information about a stream.
See: newStreamSummary
smart constructor.
StreamSummary' (Maybe Text) (Maybe StreamHealth) (Maybe ISO8601) (Maybe StreamState) (Maybe Text) (Maybe Integer) |
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.
ThumbnailConfiguration
data ThumbnailConfiguration Source #
An object representing a configuration of thumbnails for recorded video.
See: newThumbnailConfiguration
smart constructor.
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.
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' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) |
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.