| 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 |
Amazonka.MediaTailor.CreateChannel
Description
Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
Synopsis
- data CreateChannel = CreateChannel' {
- fillerSlate :: Maybe SlateSource
- tags :: Maybe (HashMap Text Text)
- tier :: Maybe Tier
- channelName :: Text
- outputs :: [RequestOutputItem]
- playbackMode :: PlaybackMode
- newCreateChannel :: Text -> PlaybackMode -> CreateChannel
- createChannel_fillerSlate :: Lens' CreateChannel (Maybe SlateSource)
- createChannel_tags :: Lens' CreateChannel (Maybe (HashMap Text Text))
- createChannel_tier :: Lens' CreateChannel (Maybe Tier)
- createChannel_channelName :: Lens' CreateChannel Text
- createChannel_outputs :: Lens' CreateChannel [RequestOutputItem]
- createChannel_playbackMode :: Lens' CreateChannel PlaybackMode
- data CreateChannelResponse = CreateChannelResponse' {
- arn :: Maybe Text
- channelName :: Maybe Text
- channelState :: Maybe ChannelState
- creationTime :: Maybe POSIX
- fillerSlate :: Maybe SlateSource
- lastModifiedTime :: Maybe POSIX
- outputs :: Maybe [ResponseOutputItem]
- playbackMode :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- tier :: Maybe Text
- httpStatus :: Int
- newCreateChannelResponse :: Int -> CreateChannelResponse
- createChannelResponse_arn :: Lens' CreateChannelResponse (Maybe Text)
- createChannelResponse_channelName :: Lens' CreateChannelResponse (Maybe Text)
- createChannelResponse_channelState :: Lens' CreateChannelResponse (Maybe ChannelState)
- createChannelResponse_creationTime :: Lens' CreateChannelResponse (Maybe UTCTime)
- createChannelResponse_fillerSlate :: Lens' CreateChannelResponse (Maybe SlateSource)
- createChannelResponse_lastModifiedTime :: Lens' CreateChannelResponse (Maybe UTCTime)
- createChannelResponse_outputs :: Lens' CreateChannelResponse (Maybe [ResponseOutputItem])
- createChannelResponse_playbackMode :: Lens' CreateChannelResponse (Maybe Text)
- createChannelResponse_tags :: Lens' CreateChannelResponse (Maybe (HashMap Text Text))
- createChannelResponse_tier :: Lens' CreateChannelResponse (Maybe Text)
- createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int
Creating a Request
data CreateChannel Source #
See: newCreateChannel smart constructor.
Constructors
| CreateChannel' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> PlaybackMode | |
| -> CreateChannel |
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_fillerSlate - The slate used to fill gaps between programs in the schedule. You must
configure filler slate if your channel uses the LINEAR PlaybackMode.
MediaTailor doesn't support filler slate for channels using the LOOP
PlaybackMode.
CreateChannel, createChannel_tags - The tags to assign to the channel. Tags are key-value pairs that you can
associate with Amazon resources to help with organization, access
control, and cost tracking. For more information, see
Tagging AWS Elemental MediaTailor Resources.
CreateChannel, createChannel_tier - The tier of the channel.
CreateChannel, createChannel_channelName - The name of the channel.
CreateChannel, createChannel_outputs - The channel's output properties.
CreateChannel, createChannel_playbackMode - The type of playback mode to use for this channel.
LINEAR - The programs in the schedule play once back-to-back in the
schedule.
LOOP - The programs in the schedule play back-to-back in an endless
loop. When the last program in the schedule stops playing, playback
loops back to the first program in the schedule.
Request Lenses
createChannel_fillerSlate :: Lens' CreateChannel (Maybe SlateSource) Source #
The slate used to fill gaps between programs in the schedule. You must
configure filler slate if your channel uses the LINEAR PlaybackMode.
MediaTailor doesn't support filler slate for channels using the LOOP
PlaybackMode.
createChannel_tags :: Lens' CreateChannel (Maybe (HashMap Text Text)) Source #
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
createChannel_tier :: Lens' CreateChannel (Maybe Tier) Source #
The tier of the channel.
createChannel_channelName :: Lens' CreateChannel Text Source #
The name of the channel.
createChannel_outputs :: Lens' CreateChannel [RequestOutputItem] Source #
The channel's output properties.
createChannel_playbackMode :: Lens' CreateChannel PlaybackMode Source #
The type of playback mode to use for this channel.
LINEAR - The programs in the schedule play once back-to-back in the
schedule.
LOOP - The programs in the schedule play back-to-back in an endless
loop. When the last program in the schedule stops playing, playback
loops back to the first program in the schedule.
Destructuring the Response
data CreateChannelResponse Source #
See: newCreateChannelResponse smart constructor.
Constructors
| CreateChannelResponse' | |
Fields
| |
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_arn - The Amazon Resource Name (ARN) to assign to the channel.
CreateChannel, createChannelResponse_channelName - The name to assign to the channel.
CreateChannelResponse, createChannelResponse_channelState - Indicates whether the channel is in a running state or not.
CreateChannelResponse, createChannelResponse_creationTime - The timestamp of when the channel was created.
CreateChannel, createChannelResponse_fillerSlate - Contains information about the slate used to fill gaps between programs
in the schedule.
CreateChannelResponse, createChannelResponse_lastModifiedTime - The timestamp of when the channel was last modified.
CreateChannel, createChannelResponse_outputs - The output properties to assign to the channel.
CreateChannel, createChannelResponse_playbackMode - The playback mode to assign to the channel.
CreateChannel, createChannelResponse_tags - The tags to assign to the channel. Tags are key-value pairs that you can
associate with Amazon resources to help with organization, access
control, and cost tracking. For more information, see
Tagging AWS Elemental MediaTailor Resources.
CreateChannel, createChannelResponse_tier - The tier of the channel.
$sel:httpStatus:CreateChannelResponse', createChannelResponse_httpStatus - The response's http status code.
Response Lenses
createChannelResponse_arn :: Lens' CreateChannelResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) to assign to the channel.
createChannelResponse_channelName :: Lens' CreateChannelResponse (Maybe Text) Source #
The name to assign to the channel.
createChannelResponse_channelState :: Lens' CreateChannelResponse (Maybe ChannelState) Source #
Indicates whether the channel is in a running state or not.
createChannelResponse_creationTime :: Lens' CreateChannelResponse (Maybe UTCTime) Source #
The timestamp of when the channel was created.
createChannelResponse_fillerSlate :: Lens' CreateChannelResponse (Maybe SlateSource) Source #
Contains information about the slate used to fill gaps between programs in the schedule.
createChannelResponse_lastModifiedTime :: Lens' CreateChannelResponse (Maybe UTCTime) Source #
The timestamp of when the channel was last modified.
createChannelResponse_outputs :: Lens' CreateChannelResponse (Maybe [ResponseOutputItem]) Source #
The output properties to assign to the channel.
createChannelResponse_playbackMode :: Lens' CreateChannelResponse (Maybe Text) Source #
The playback mode to assign to the channel.
createChannelResponse_tags :: Lens' CreateChannelResponse (Maybe (HashMap Text Text)) Source #
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
createChannelResponse_tier :: Lens' CreateChannelResponse (Maybe Text) Source #
The tier of the channel.
createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int Source #
The response's http status code.