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

Amazonka.IVS.Lens

Description

 
Synopsis

Operations

PutMetadata

putMetadata_channelArn :: Lens' PutMetadata Text Source #

ARN of the channel into which metadata is inserted. This channel must have an active stream.

putMetadata_metadata :: Lens' PutMetadata Text Source #

Metadata to insert into the stream. Maximum: 1 KB per request.

ListRecordingConfigurations

listRecordingConfigurations_nextToken :: Lens' ListRecordingConfigurations (Maybe Text) Source #

The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

listRecordingConfigurations_maxResults :: Lens' ListRecordingConfigurations (Maybe Natural) Source #

Maximum number of recording configurations to return. Default: 50.

listRecordingConfigurationsResponse_nextToken :: Lens' ListRecordingConfigurationsResponse (Maybe Text) Source #

If there are more recording configurations than maxResults, use nextToken in the request to get the next set.

CreateStreamKey

createStreamKey_tags :: Lens' CreateStreamKey (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

createStreamKey_channelArn :: Lens' CreateStreamKey Text Source #

ARN of the channel for which to create the stream key.

createStreamKeyResponse_streamKey :: Lens' CreateStreamKeyResponse (Maybe StreamKey) Source #

Stream key used to authenticate an RTMPS stream for ingestion.

ImportPlaybackKeyPair

importPlaybackKeyPair_name :: Lens' ImportPlaybackKeyPair (Maybe Text) Source #

Playback-key-pair name. The value does not need to be unique.

importPlaybackKeyPair_tags :: Lens' ImportPlaybackKeyPair (Maybe (HashMap Text Text)) Source #

Any tags provided with the request are added to the playback key pair tags.

importPlaybackKeyPair_publicKeyMaterial :: Lens' ImportPlaybackKeyPair Text Source #

The public portion of a customer-generated key pair.

ListChannels

listChannels_filterByName :: Lens' ListChannels (Maybe Text) Source #

Filters the channel list to match the specified name.

listChannels_nextToken :: Lens' ListChannels (Maybe Text) Source #

The first channel to retrieve. This is used for pagination; see the nextToken response field.

listChannels_filterByRecordingConfigurationArn :: Lens' ListChannels (Maybe Text) Source #

Filters the channel list to match the specified recording-configuration ARN.

listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #

Maximum number of channels to return. Default: 50.

listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #

If there are more channels than maxResults, use nextToken in the request to get the next set.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The ARN of the resource to be retrieved.

DeleteChannel

deleteChannel_arn :: Lens' DeleteChannel Text Source #

ARN of the channel to be deleted.

UpdateChannel

updateChannel_authorized :: Lens' UpdateChannel (Maybe Bool) Source #

Whether the channel is private (enabled for playback authorization).

updateChannel_latencyMode :: Lens' UpdateChannel (Maybe ChannelLatencyMode) Source #

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

updateChannel_recordingConfigurationArn :: Lens' UpdateChannel (Maybe Text) Source #

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_type :: Lens' UpdateChannel (Maybe ChannelType) Source #

Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately/. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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.
  • BASIC: 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 480p and bitrate can be up to 1.5 Mbps.

updateChannel_arn :: Lens' UpdateChannel Text Source #

ARN of the channel to be updated.

GetStreamKey

getStreamKey_arn :: Lens' GetStreamKey Text Source #

ARN for the stream key to be retrieved.

DeletePlaybackKeyPair

deletePlaybackKeyPair_arn :: Lens' DeletePlaybackKeyPair Text Source #

ARN of the key pair to be deleted.

BatchGetStreamKey

batchGetStreamKey_arns :: Lens' BatchGetStreamKey (NonEmpty Text) Source #

Array of ARNs, one per channel.

GetPlaybackKeyPair

getPlaybackKeyPair_arn :: Lens' GetPlaybackKeyPair Text Source #

ARN of the key pair to be returned.

DeleteRecordingConfiguration

deleteRecordingConfiguration_arn :: Lens' DeleteRecordingConfiguration Text Source #

ARN of the recording configuration to be deleted.

StopStream

stopStream_channelArn :: Lens' StopStream Text Source #

ARN of the channel for which the stream is to be stopped.

CreateChannel

createChannel_authorized :: Lens' CreateChannel (Maybe Bool) Source #

Whether the channel is private (enabled for playback authorization). Default: false.

createChannel_latencyMode :: Lens' CreateChannel (Maybe ChannelLatencyMode) Source #

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

createChannel_recordingConfigurationArn :: Lens' CreateChannel (Maybe Text) Source #

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

createChannel_type :: Lens' CreateChannel (Maybe ChannelType) Source #

Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately./ Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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.
  • BASIC: 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 480p and bitrate can be up to 1.5 Mbps.

createChannel_tags :: Lens' CreateChannel (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

DeleteStreamKey

deleteStreamKey_arn :: Lens' DeleteStreamKey Text Source #

ARN of the stream key to be deleted.

GetStream

getStream_channelArn :: Lens' GetStream Text Source #

Channel ARN for stream to be accessed.

getStreamResponse_httpStatus :: Lens' GetStreamResponse Int Source #

The response's http status code.

ListStreamKeys

listStreamKeys_nextToken :: Lens' ListStreamKeys (Maybe Text) Source #

The first stream key to retrieve. This is used for pagination; see the nextToken response field.

listStreamKeys_maxResults :: Lens' ListStreamKeys (Maybe Natural) Source #

Maximum number of streamKeys to return. Default: 50.

listStreamKeys_channelArn :: Lens' ListStreamKeys Text Source #

Channel ARN used to filter the list.

listStreamKeysResponse_nextToken :: Lens' ListStreamKeysResponse (Maybe Text) Source #

If there are more stream keys than maxResults, use nextToken in the request to get the next set.

GetChannel

getChannel_arn :: Lens' GetChannel Text Source #

ARN of the channel for which the configuration is to be retrieved.

ListStreams

listStreams_nextToken :: Lens' ListStreams (Maybe Text) Source #

The first stream to retrieve. This is used for pagination; see the nextToken response field.

listStreams_maxResults :: Lens' ListStreams (Maybe Natural) Source #

Maximum number of streams to return. Default: 50.

listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #

If there are more streams than maxResults, use nextToken in the request to get the next set.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

ARN of the resource for which tags are to be added or updated.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Array of tags to be added or updated.

GetRecordingConfiguration

getRecordingConfiguration_arn :: Lens' GetRecordingConfiguration Text Source #

ARN of the recording configuration to be retrieved.

ListPlaybackKeyPairs

listPlaybackKeyPairs_nextToken :: Lens' ListPlaybackKeyPairs (Maybe Text) Source #

Maximum number of key pairs to return.

listPlaybackKeyPairs_maxResults :: Lens' ListPlaybackKeyPairs (Maybe Natural) Source #

The first key pair to retrieve. This is used for pagination; see the nextToken response field. Default: 50.

listPlaybackKeyPairsResponse_nextToken :: Lens' ListPlaybackKeyPairsResponse (Maybe Text) Source #

If there are more key pairs than maxResults, use nextToken in the request to get the next set.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

ARN of the resource for which tags are to be removed.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

Array of tags to be removed.

CreateRecordingConfiguration

createRecordingConfiguration_name :: Lens' CreateRecordingConfiguration (Maybe Text) Source #

Recording-configuration name. The value does not need to be unique.

createRecordingConfiguration_tags :: Lens' CreateRecordingConfiguration (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

createRecordingConfiguration_destinationConfiguration :: Lens' CreateRecordingConfiguration DestinationConfiguration Source #

A complex type that contains a destination configuration for where recorded video will be stored.

BatchGetChannel

batchGetChannel_arns :: Lens' BatchGetChannel (NonEmpty Text) Source #

Array of ARNs, one per channel.

batchGetChannelResponse_errors :: Lens' BatchGetChannelResponse (Maybe [BatchError]) Source #

Each error object is related to a specific ARN in the request.

Types

BatchError

batchError_message :: Lens' BatchError (Maybe Text) Source #

Error message, determined by the application.

Channel

channel_playbackUrl :: Lens' Channel (Maybe Text) Source #

Channel playback URL.

channel_authorized :: Lens' Channel (Maybe Bool) Source #

Whether the channel is private (enabled for playback authorization). Default: false.

channel_latencyMode :: Lens' Channel (Maybe ChannelLatencyMode) Source #

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

channel_recordingConfigurationArn :: Lens' Channel (Maybe Text) Source #

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

channel_type :: Lens' Channel (Maybe ChannelType) Source #

Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately./ Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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.
  • BASIC: 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 480p and bitrate can be up to 1.5 Mbps.

channel_tags :: Lens' Channel (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

channel_ingestEndpoint :: Lens' Channel (Maybe Text) Source #

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

ChannelSummary

channelSummary_authorized :: Lens' ChannelSummary (Maybe Bool) Source #

Whether the channel is private (enabled for playback authorization). Default: false.

channelSummary_latencyMode :: Lens' ChannelSummary (Maybe ChannelLatencyMode) Source #

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

channelSummary_recordingConfigurationArn :: Lens' ChannelSummary (Maybe Text) Source #

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

channelSummary_tags :: Lens' ChannelSummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

DestinationConfiguration

destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration) Source #

An S3 destination configuration where recorded videos will be stored.

PlaybackKeyPair

playbackKeyPair_name :: Lens' PlaybackKeyPair (Maybe Text) Source #

Playback-key-pair name. The value does not need to be unique.

playbackKeyPair_tags :: Lens' PlaybackKeyPair (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

PlaybackKeyPairSummary

playbackKeyPairSummary_name :: Lens' PlaybackKeyPairSummary (Maybe Text) Source #

Playback-key-pair name. The value does not need to be unique.

playbackKeyPairSummary_tags :: Lens' PlaybackKeyPairSummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

RecordingConfiguration

recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text) Source #

Recording-configuration name. The value does not need to be unique.

recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration Source #

A complex type that contains information about where recorded video will be stored.

recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState Source #

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

RecordingConfigurationSummary

recordingConfigurationSummary_name :: Lens' RecordingConfigurationSummary (Maybe Text) Source #

Recording-configuration name. The value does not need to be unique.

recordingConfigurationSummary_tags :: Lens' RecordingConfigurationSummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

recordingConfigurationSummary_destinationConfiguration :: Lens' RecordingConfigurationSummary DestinationConfiguration Source #

A complex type that contains information about where recorded video will be stored.

recordingConfigurationSummary_state :: Lens' RecordingConfigurationSummary RecordingConfigurationState Source #

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

S3DestinationConfiguration

s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text Source #

Location (S3 bucket name) where recorded videos will be stored.

Stream

stream_playbackUrl :: Lens' Stream (Maybe Text) Source #

URL of the master playlist, required by the video player to play the HLS stream.

stream_state :: Lens' Stream (Maybe StreamState) Source #

The stream’s state.

stream_startTime :: Lens' Stream (Maybe UTCTime) Source #

Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

stream_channelArn :: Lens' Stream (Maybe Text) Source #

Channel ARN for the stream.

stream_viewerCount :: Lens' Stream (Maybe Integer) Source #

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

stream_health :: Lens' Stream (Maybe StreamHealth) Source #

The stream’s health.

StreamKey

streamKey_channelArn :: Lens' StreamKey (Maybe Text) Source #

Channel ARN for the stream.

streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

StreamKeySummary

streamKeySummary_tags :: Lens' StreamKeySummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

StreamSummary

streamSummary_startTime :: Lens' StreamSummary (Maybe UTCTime) Source #

Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

streamSummary_viewerCount :: Lens' StreamSummary (Maybe Integer) Source #

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.