channels

Creates, updates, deletes, gets or lists a channels resource.

Overview

Name	channels
Type	Resource
Id	aws.medialive.channels

Fields

The following fields are returned by SELECT queries:

describe_channel

Name	Datatype	Description
anywhere_settings	object	Anywhere settings for this channel.
arn	string	Placeholder documentation for __string
cdi_input_specification	object	Placeholder documentation for CdiInputSpecification
channel_class	string	A standard channel has two encoding pipelines and a single pipeline channel only has one. (STANDARD, SINGLE_PIPELINE)
channel_engine_version	object	Placeholder documentation for ChannelEngineVersionResponse
channel_security_groups	array	Placeholder documentation for __listOf__string
destinations	array	Placeholder documentation for __listOfOutputDestination
egress_endpoints	array	The endpoints where outgoing connections initiate from
encoder_settings	object	Encoder Settings
id	string	Placeholder documentation for __string
inference_settings	object	Include this setting to include Elemental Inference features in this channel.
input_attachments	array	Placeholder documentation for __listOfInputAttachment
input_specification	object	Placeholder documentation for InputSpecification
linked_channel_settings	object	Linked Channel Settings for this channel.
log_level	string	The log level the user wants for their channel. (ERROR, WARNING, INFO, DEBUG, DISABLED)
maintenance	object	Maintenance settings for this channel.
name	string	Placeholder documentation for __string
pipeline_details	array	Runtime details for the pipelines of a running channel.
pipelines_running_count	integer	Placeholder documentation for __integer
role_arn	string	Placeholder documentation for __string
state	string	Placeholder documentation for ChannelState (CREATING, CREATE_FAILED, IDLE, STARTING, RUNNING, RECOVERING, STOPPING, DELETING, DELETED, UPDATING, UPDATE_FAILED)
tags	object	A collection of key-value pairs.
vpc	object	Settings for VPC output

list_channels

Name	Datatype	Description
anywhere_settings	object	AnywhereSettings settings for this channel.
arn	string	Placeholder documentation for __string
cdi_input_specification	object	Placeholder documentation for CdiInputSpecification
channel_class	string	A standard channel has two encoding pipelines and a single pipeline channel only has one. (STANDARD, SINGLE_PIPELINE)
channel_engine_version	object	The engine version that you requested for this channel.
channel_security_groups	array	Placeholder documentation for __listOf__string
destinations	array	Placeholder documentation for __listOfOutputDestination
egress_endpoints	array	The endpoints where outgoing connections initiate from
id	string	Placeholder documentation for __string
inference_settings	object	Include this setting to include Elemental Inference features in this channel.
input_attachments	array	Placeholder documentation for __listOfInputAttachment
input_specification	object	Placeholder documentation for InputSpecification
linked_channel_settings	object	Linked Channel Settings for this channel.
log_level	string	The log level the user wants for their channel. (ERROR, WARNING, INFO, DEBUG, DISABLED)
maintenance	object	Maintenance settings for this channel.
name	string	Placeholder documentation for __string
pipelines_running_count	integer	The number of currently healthy pipelines.
role_arn	string	Placeholder documentation for __string
state	string	Placeholder documentation for ChannelState (CREATING, CREATE_FAILED, IDLE, STARTING, RUNNING, RECOVERING, STOPPING, DELETING, DELETED, UPDATING, UPDATE_FAILED)
tags	object	A collection of key-value pairs.
used_channel_engine_versions	array	The engine version that the running pipelines are using.
vpc	object	Settings for any VPC outputs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_channel	select	channel_id, region		Gets details about a channel
list_channels	select	region	maxResults, nextToken	Produces list of channels that have been created
create_channel	insert	region		Creates a new channel
update_channel_class	update	channel_id, region, ChannelClass		Changes the class of the channel.
update_channel	update	channel_id, region		Updates a channel.
delete_channel	delete	channel_id, region		Starts deletion of channel. The associated outputs are also deleted.
batch_update_schedule	exec	channel_id, region		Update a channel schedule
restart_channel_pipelines	exec	channel_id, region		Restart pipelines in one channel that is currently running.
start_channel	exec	channel_id, region		Starts an existing channel
stop_channel	exec	channel_id, region		Stops a running channel

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
channel_id	string	A request to stop a running channel
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string

SELECT examples

describe_channel

Gets details about a channel

SELECT
anywhere_settings,
arn,
cdi_input_specification,
channel_class,
channel_engine_version,
channel_security_groups,
destinations,
egress_endpoints,
encoder_settings,
id,
inference_settings,
input_attachments,
input_specification,
linked_channel_settings,
log_level,
maintenance,
name,
pipeline_details,
pipelines_running_count,
role_arn,
state,
tags,
vpc
FROM aws.medialive.channels
WHERE channel_id = '{{ channel_id }}' -- required
AND region = '{{ region }}' -- required
;

list_channels

Produces list of channels that have been created

SELECT
anywhere_settings,
arn,
cdi_input_specification,
channel_class,
channel_engine_version,
channel_security_groups,
destinations,
egress_endpoints,
id,
inference_settings,
input_attachments,
input_specification,
linked_channel_settings,
log_level,
maintenance,
name,
pipelines_running_count,
role_arn,
state,
tags,
used_channel_engine_versions,
vpc
FROM aws.medialive.channels
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_channel

Creates a new channel

INSERT INTO aws.medialive.channels (
CdiInputSpecification,
ChannelClass,
Destinations,
EncoderSettings,
InputAttachments,
InputSpecification,
LogLevel,
Maintenance,
Name,
RequestId,
Reserved,
RoleArn,
Tags,
Vpc,
AnywhereSettings,
ChannelEngineVersion,
DryRun,
LinkedChannelSettings,
ChannelSecurityGroups,
InferenceSettings,
region
)
SELECT 
'{{ CdiInputSpecification }}',
'{{ ChannelClass }}',
'{{ Destinations }}',
'{{ EncoderSettings }}',
'{{ InputAttachments }}',
'{{ InputSpecification }}',
'{{ LogLevel }}',
'{{ Maintenance }}',
'{{ Name }}',
'{{ RequestId }}',
'{{ Reserved }}',
'{{ RoleArn }}',
'{{ Tags }}',
'{{ Vpc }}',
'{{ AnywhereSettings }}',
'{{ ChannelEngineVersion }}',
{{ DryRun }},
'{{ LinkedChannelSettings }}',
'{{ ChannelSecurityGroups }}',
'{{ InferenceSettings }}',
'{{ region }}'
RETURNING
channel
;

Manifest

# Description fields are for documentation purposes
- name: channels
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the channels resource.
  - name: CdiInputSpecification
    description: |
      Placeholder documentation for CdiInputSpecification
    value:
      Resolution: "{{ Resolution }}"
  - name: ChannelClass
    value: "{{ ChannelClass }}"
    description: |
      A standard channel has two encoding pipelines and a single pipeline channel only has one.
    valid_values: ['STANDARD', 'SINGLE_PIPELINE']
  - name: Destinations
    description: |
      Placeholder documentation for __listOfOutputDestination
    value:
      - Id: "{{ Id }}"
        MediaPackageSettings: "{{ MediaPackageSettings }}"
        MultiplexSettings:
          MultiplexId: "{{ MultiplexId }}"
          ProgramName: "{{ ProgramName }}"
        Settings: "{{ Settings }}"
        SrtSettings: "{{ SrtSettings }}"
        LogicalInterfaceNames: "{{ LogicalInterfaceNames }}"
        MediaConnectRouterSettings: "{{ MediaConnectRouterSettings }}"
  - name: EncoderSettings
    description: |
      Encoder Settings
    value:
      AudioDescriptions:
        - AudioNormalizationSettings:
            Algorithm: "{{ Algorithm }}"
            AlgorithmControl: "{{ AlgorithmControl }}"
            TargetLkfs: {{ TargetLkfs }}
            PeakCalculation: "{{ PeakCalculation }}"
            PeakLimiterThreshold: {{ PeakLimiterThreshold }}
          AudioSelectorName: "{{ AudioSelectorName }}"
          AudioType: "{{ AudioType }}"
          AudioTypeControl: "{{ AudioTypeControl }}"
          AudioWatermarkingSettings:
            NielsenWatermarksSettings:
              NielsenCbetSettings:
                CbetCheckDigitString: "{{ CbetCheckDigitString }}"
                CbetStepaside: "{{ CbetStepaside }}"
                Csid: "{{ Csid }}"
              NielsenDistributionType: "{{ NielsenDistributionType }}"
              NielsenNaesIiNwSettings:
                CheckDigitString: "{{ CheckDigitString }}"
                Sid: {{ Sid }}
                Timezone: "{{ Timezone }}"
              NielsenNwOnlySettings:
                CheckDigitString: "{{ CheckDigitString }}"
                Sid: {{ Sid }}
                Timezone: "{{ Timezone }}"
          CodecSettings:
            AacSettings:
              Bitrate: {{ Bitrate }}
              CodingMode: "{{ CodingMode }}"
              InputType: "{{ InputType }}"
              Profile: "{{ Profile }}"
              RateControlMode: "{{ RateControlMode }}"
              RawFormat: "{{ RawFormat }}"
              SampleRate: {{ SampleRate }}
              Spec: "{{ Spec }}"
              VbrQuality: "{{ VbrQuality }}"
            Ac3Settings:
              Bitrate: {{ Bitrate }}
              BitstreamMode: "{{ BitstreamMode }}"
              CodingMode: "{{ CodingMode }}"
              Dialnorm: {{ Dialnorm }}
              DrcProfile: "{{ DrcProfile }}"
              LfeFilter: "{{ LfeFilter }}"
              MetadataControl: "{{ MetadataControl }}"
              AttenuationControl: "{{ AttenuationControl }}"
            Eac3AtmosSettings:
              Bitrate: {{ Bitrate }}
              CodingMode: "{{ CodingMode }}"
              Dialnorm: {{ Dialnorm }}
              DrcLine: "{{ DrcLine }}"
              DrcRf: "{{ DrcRf }}"
              HeightTrim: {{ HeightTrim }}
              SurroundTrim: {{ SurroundTrim }}
            Eac3Settings:
              AttenuationControl: "{{ AttenuationControl }}"
              Bitrate: {{ Bitrate }}
              BitstreamMode: "{{ BitstreamMode }}"
              CodingMode: "{{ CodingMode }}"
              DcFilter: "{{ DcFilter }}"
              Dialnorm: {{ Dialnorm }}
              DrcLine: "{{ DrcLine }}"
              DrcRf: "{{ DrcRf }}"
              LfeControl: "{{ LfeControl }}"
              LfeFilter: "{{ LfeFilter }}"
              LoRoCenterMixLevel: {{ LoRoCenterMixLevel }}
              LoRoSurroundMixLevel: {{ LoRoSurroundMixLevel }}
              LtRtCenterMixLevel: {{ LtRtCenterMixLevel }}
              LtRtSurroundMixLevel: {{ LtRtSurroundMixLevel }}
              MetadataControl: "{{ MetadataControl }}"
              PassthroughControl: "{{ PassthroughControl }}"
              PhaseControl: "{{ PhaseControl }}"
              StereoDownmix: "{{ StereoDownmix }}"
              SurroundExMode: "{{ SurroundExMode }}"
              SurroundMode: "{{ SurroundMode }}"
            Mp2Settings:
              Bitrate: {{ Bitrate }}
              CodingMode: "{{ CodingMode }}"
              SampleRate: {{ SampleRate }}
            PassThroughSettings: "{{ PassThroughSettings }}"
            WavSettings:
              BitDepth: {{ BitDepth }}
              CodingMode: "{{ CodingMode }}"
              SampleRate: {{ SampleRate }}
          LanguageCode: "{{ LanguageCode }}"
          LanguageCodeControl: "{{ LanguageCodeControl }}"
          Name: "{{ Name }}"
          RemixSettings:
            ChannelMappings:
              - InputChannelLevels: "{{ InputChannelLevels }}"
                OutputChannel: {{ OutputChannel }}
            ChannelsIn: {{ ChannelsIn }}
            ChannelsOut: {{ ChannelsOut }}
          StreamName: "{{ StreamName }}"
          AudioDashRoles: "{{ AudioDashRoles }}"
          DvbDashAccessibility: "{{ DvbDashAccessibility }}"
      AvailBlanking:
        AvailBlankingImage:
          PasswordParam: "{{ PasswordParam }}"
          Uri: "{{ Uri }}"
          Username: "{{ Username }}"
        State: "{{ State }}"
      AvailConfiguration:
        AvailSettings:
          Esam:
            AcquisitionPointId: "{{ AcquisitionPointId }}"
            AdAvailOffset: {{ AdAvailOffset }}
            PasswordParam: "{{ PasswordParam }}"
            PoisEndpoint: "{{ PoisEndpoint }}"
            Username: "{{ Username }}"
            ZoneIdentity: "{{ ZoneIdentity }}"
          Scte35SpliceInsert:
            AdAvailOffset: {{ AdAvailOffset }}
            NoRegionalBlackoutFlag: "{{ NoRegionalBlackoutFlag }}"
            WebDeliveryAllowedFlag: "{{ WebDeliveryAllowedFlag }}"
          Scte35TimeSignalApos:
            AdAvailOffset: {{ AdAvailOffset }}
            NoRegionalBlackoutFlag: "{{ NoRegionalBlackoutFlag }}"
            WebDeliveryAllowedFlag: "{{ WebDeliveryAllowedFlag }}"
        Scte35SegmentationScope: "{{ Scte35SegmentationScope }}"
      BlackoutSlate:
        BlackoutSlateImage:
          PasswordParam: "{{ PasswordParam }}"
          Uri: "{{ Uri }}"
          Username: "{{ Username }}"
        NetworkEndBlackout: "{{ NetworkEndBlackout }}"
        NetworkEndBlackoutImage:
          PasswordParam: "{{ PasswordParam }}"
          Uri: "{{ Uri }}"
          Username: "{{ Username }}"
        NetworkId: "{{ NetworkId }}"
        State: "{{ State }}"
      CaptionDescriptions:
        - Accessibility: "{{ Accessibility }}"
          CaptionSelectorName: "{{ CaptionSelectorName }}"
          DestinationSettings:
            AribDestinationSettings: "{{ AribDestinationSettings }}"
            BurnInDestinationSettings:
              Alignment: "{{ Alignment }}"
              BackgroundColor: "{{ BackgroundColor }}"
              BackgroundOpacity: {{ BackgroundOpacity }}
              Font:
                PasswordParam: "{{ PasswordParam }}"
                Uri: "{{ Uri }}"
                Username: "{{ Username }}"
              FontColor: "{{ FontColor }}"
              FontOpacity: {{ FontOpacity }}
              FontResolution: {{ FontResolution }}
              FontSize: "{{ FontSize }}"
              OutlineColor: "{{ OutlineColor }}"
              OutlineSize: {{ OutlineSize }}
              ShadowColor: "{{ ShadowColor }}"
              ShadowOpacity: {{ ShadowOpacity }}
              ShadowXOffset: {{ ShadowXOffset }}
              ShadowYOffset: {{ ShadowYOffset }}
              TeletextGridControl: "{{ TeletextGridControl }}"
              XPosition: {{ XPosition }}
              YPosition: {{ YPosition }}
              SubtitleRows: "{{ SubtitleRows }}"
            DvbSubDestinationSettings:
              Alignment: "{{ Alignment }}"
              BackgroundColor: "{{ BackgroundColor }}"
              BackgroundOpacity: {{ BackgroundOpacity }}
              Font:
                PasswordParam: "{{ PasswordParam }}"
                Uri: "{{ Uri }}"
                Username: "{{ Username }}"
              FontColor: "{{ FontColor }}"
              FontOpacity: {{ FontOpacity }}
              FontResolution: {{ FontResolution }}
              FontSize: "{{ FontSize }}"
              OutlineColor: "{{ OutlineColor }}"
              OutlineSize: {{ OutlineSize }}
              ShadowColor: "{{ ShadowColor }}"
              ShadowOpacity: {{ ShadowOpacity }}
              ShadowXOffset: {{ ShadowXOffset }}
              ShadowYOffset: {{ ShadowYOffset }}
              TeletextGridControl: "{{ TeletextGridControl }}"
              XPosition: {{ XPosition }}
              YPosition: {{ YPosition }}
              SubtitleRows: "{{ SubtitleRows }}"
            EbuTtDDestinationSettings:
              CopyrightHolder: "{{ CopyrightHolder }}"
              FillLineGap: "{{ FillLineGap }}"
              FontFamily: "{{ FontFamily }}"
              StyleControl: "{{ StyleControl }}"
              DefaultFontSize: {{ DefaultFontSize }}
              DefaultLineHeight: {{ DefaultLineHeight }}
            EmbeddedDestinationSettings: "{{ EmbeddedDestinationSettings }}"
            EmbeddedPlusScte20DestinationSettings: "{{ EmbeddedPlusScte20DestinationSettings }}"
            RtmpCaptionInfoDestinationSettings: "{{ RtmpCaptionInfoDestinationSettings }}"
            Scte20PlusEmbeddedDestinationSettings: "{{ Scte20PlusEmbeddedDestinationSettings }}"
            Scte27DestinationSettings: "{{ Scte27DestinationSettings }}"
            SmpteTtDestinationSettings: "{{ SmpteTtDestinationSettings }}"
            TeletextDestinationSettings: "{{ TeletextDestinationSettings }}"
            TtmlDestinationSettings:
              StyleControl: "{{ StyleControl }}"
            WebvttDestinationSettings:
              StyleControl: "{{ StyleControl }}"
          LanguageCode: "{{ LanguageCode }}"
          LanguageDescription: "{{ LanguageDescription }}"
          Name: "{{ Name }}"
          CaptionDashRoles: "{{ CaptionDashRoles }}"
          DvbDashAccessibility: "{{ DvbDashAccessibility }}"
      FeatureActivations:
        InputPrepareScheduleActions: "{{ InputPrepareScheduleActions }}"
        OutputStaticImageOverlayScheduleActions: "{{ OutputStaticImageOverlayScheduleActions }}"
      GlobalConfiguration:
        InitialAudioGain: {{ InitialAudioGain }}
        InputEndAction: "{{ InputEndAction }}"
        InputLossBehavior:
          BlackFrameMsec: {{ BlackFrameMsec }}
          InputLossImageColor: "{{ InputLossImageColor }}"
          InputLossImageSlate:
            PasswordParam: "{{ PasswordParam }}"
            Uri: "{{ Uri }}"
            Username: "{{ Username }}"
          InputLossImageType: "{{ InputLossImageType }}"
          RepeatFrameMsec: {{ RepeatFrameMsec }}
        OutputLockingMode: "{{ OutputLockingMode }}"
        OutputTimingSource: "{{ OutputTimingSource }}"
        SupportLowFramerateInputs: "{{ SupportLowFramerateInputs }}"
        OutputLockingSettings:
          EpochLockingSettings:
            CustomEpoch: "{{ CustomEpoch }}"
            JamSyncTime: "{{ JamSyncTime }}"
          PipelineLockingSettings:
            PipelineLockingMethod: "{{ PipelineLockingMethod }}"
            CustomEpoch: "{{ CustomEpoch }}"
          DisabledLockingSettings:
            CustomEpoch: "{{ CustomEpoch }}"
      MotionGraphicsConfiguration:
        MotionGraphicsInsertion: "{{ MotionGraphicsInsertion }}"
        MotionGraphicsSettings:
          HtmlMotionGraphicsSettings: "{{ HtmlMotionGraphicsSettings }}"
      NielsenConfiguration:
        DistributorId: "{{ DistributorId }}"
        NielsenPcmToId3Tagging: "{{ NielsenPcmToId3Tagging }}"
      OutputGroups:
        - Name: "{{ Name }}"
          OutputGroupSettings:
            ArchiveGroupSettings:
              ArchiveCdnSettings:
                ArchiveS3Settings: "{{ ArchiveS3Settings }}"
              Destination:
                DestinationRefId: "{{ DestinationRefId }}"
              RolloverInterval: {{ RolloverInterval }}
            FrameCaptureGroupSettings:
              Destination:
                DestinationRefId: "{{ DestinationRefId }}"
              FrameCaptureCdnSettings:
                FrameCaptureS3Settings: "{{ FrameCaptureS3Settings }}"
            HlsGroupSettings:
              AdMarkers:
                - "{{ AdMarkers }}"
              BaseUrlContent: "{{ BaseUrlContent }}"
              BaseUrlContent1: "{{ BaseUrlContent1 }}"
              BaseUrlManifest: "{{ BaseUrlManifest }}"
              BaseUrlManifest1: "{{ BaseUrlManifest1 }}"
              CaptionLanguageMappings:
                - CaptionChannel: {{ CaptionChannel }}
                  LanguageCode: "{{ LanguageCode }}"
                  LanguageDescription: "{{ LanguageDescription }}"
              CaptionLanguageSetting: "{{ CaptionLanguageSetting }}"
              ClientCache: "{{ ClientCache }}"
              CodecSpecification: "{{ CodecSpecification }}"
              ConstantIv: "{{ ConstantIv }}"
              Destination:
                DestinationRefId: "{{ DestinationRefId }}"
              DirectoryStructure: "{{ DirectoryStructure }}"
              DiscontinuityTags: "{{ DiscontinuityTags }}"
              EncryptionType: "{{ EncryptionType }}"
              HlsCdnSettings:
                HlsAkamaiSettings: "{{ HlsAkamaiSettings }}"
                HlsBasicPutSettings: "{{ HlsBasicPutSettings }}"
                HlsMediaStoreSettings: "{{ HlsMediaStoreSettings }}"
                HlsS3Settings: "{{ HlsS3Settings }}"
                HlsWebdavSettings: "{{ HlsWebdavSettings }}"
              HlsId3SegmentTagging: "{{ HlsId3SegmentTagging }}"
              IFrameOnlyPlaylists: "{{ IFrameOnlyPlaylists }}"
              IncompleteSegmentBehavior: "{{ IncompleteSegmentBehavior }}"
              IndexNSegments: {{ IndexNSegments }}
              InputLossAction: "{{ InputLossAction }}"
              IvInManifest: "{{ IvInManifest }}"
              IvSource: "{{ IvSource }}"
              KeepSegments: {{ KeepSegments }}
              KeyFormat: "{{ KeyFormat }}"
              KeyFormatVersions: "{{ KeyFormatVersions }}"
              KeyProviderSettings:
                StaticKeySettings: "{{ StaticKeySettings }}"
              ManifestCompression: "{{ ManifestCompression }}"
              ManifestDurationFormat: "{{ ManifestDurationFormat }}"
              MinSegmentLength: {{ MinSegmentLength }}
              Mode: "{{ Mode }}"
              OutputSelection: "{{ OutputSelection }}"
              ProgramDateTime: "{{ ProgramDateTime }}"
              ProgramDateTimeClock: "{{ ProgramDateTimeClock }}"
              ProgramDateTimePeriod: {{ ProgramDateTimePeriod }}
              RedundantManifest: "{{ RedundantManifest }}"
              SegmentLength: {{ SegmentLength }}
              SegmentationMode: "{{ SegmentationMode }}"
              SegmentsPerSubdirectory: {{ SegmentsPerSubdirectory }}
              StreamInfResolution: "{{ StreamInfResolution }}"
              TimedMetadataId3Frame: "{{ TimedMetadataId3Frame }}"
              TimedMetadataId3Period: {{ TimedMetadataId3Period }}
              TimestampDeltaMilliseconds: {{ TimestampDeltaMilliseconds }}
              TsFileMode: "{{ TsFileMode }}"
            MediaPackageGroupSettings:
              Destination:
                DestinationRefId: "{{ DestinationRefId }}"
              MediapackageV2GroupSettings:
                CaptionLanguageMappings: "{{ CaptionLanguageMappings }}"
                Id3Behavior: "{{ Id3Behavior }}"
                KlvBehavior: "{{ KlvBehavior }}"
                NielsenId3Behavior: "{{ NielsenId3Behavior }}"
                Scte35Type: "{{ Scte35Type }}"
                SegmentLength: {{ SegmentLength }}
                SegmentLengthUnits: "{{ SegmentLengthUnits }}"
                TimedMetadataId3Frame: "{{ TimedMetadataId3Frame }}"
                TimedMetadataId3Period: {{ TimedMetadataId3Period }}
                TimedMetadataPassthrough: "{{ TimedMetadataPassthrough }}"
                AdditionalDestinations: "{{ AdditionalDestinations }}"
            MsSmoothGroupSettings:
              AcquisitionPointId: "{{ AcquisitionPointId }}"
              AudioOnlyTimecodeControl: "{{ AudioOnlyTimecodeControl }}"
              CertificateMode: "{{ CertificateMode }}"
              ConnectionRetryInterval: {{ ConnectionRetryInterval }}
              Destination:
                DestinationRefId: "{{ DestinationRefId }}"
              EventId: "{{ EventId }}"
              EventIdMode: "{{ EventIdMode }}"
              EventStopBehavior: "{{ EventStopBehavior }}"
              FilecacheDuration: {{ FilecacheDuration }}
              FragmentLength: {{ FragmentLength }}
              InputLossAction: "{{ InputLossAction }}"
              NumRetries: {{ NumRetries }}
              RestartDelay: {{ RestartDelay }}
              SegmentationMode: "{{ SegmentationMode }}"
              SendDelayMs: {{ SendDelayMs }}
              SparseTrackType: "{{ SparseTrackType }}"
              StreamManifestBehavior: "{{ StreamManifestBehavior }}"
              TimestampOffset: "{{ TimestampOffset }}"
              TimestampOffsetMode: "{{ TimestampOffsetMode }}"
            MultiplexGroupSettings: "{{ MultiplexGroupSettings }}"
            RtmpGroupSettings:
              AdMarkers:
                - "{{ AdMarkers }}"
              AuthenticationScheme: "{{ AuthenticationScheme }}"
              CacheFullBehavior: "{{ CacheFullBehavior }}"
              CacheLength: {{ CacheLength }}
              CaptionData: "{{ CaptionData }}"
              InputLossAction: "{{ InputLossAction }}"
              RestartDelay: {{ RestartDelay }}
              IncludeFillerNalUnits: "{{ IncludeFillerNalUnits }}"
            UdpGroupSettings:
              InputLossAction: "{{ InputLossAction }}"
              TimedMetadataId3Frame: "{{ TimedMetadataId3Frame }}"
              TimedMetadataId3Period: {{ TimedMetadataId3Period }}
            CmafIngestGroupSettings:
              Destination:
                DestinationRefId: "{{ DestinationRefId }}"
              NielsenId3Behavior: "{{ NielsenId3Behavior }}"
              Scte35Type: "{{ Scte35Type }}"
              SegmentLength: {{ SegmentLength }}
              SegmentLengthUnits: "{{ SegmentLengthUnits }}"
              SendDelayMs: {{ SendDelayMs }}
              KlvBehavior: "{{ KlvBehavior }}"
              KlvNameModifier: "{{ KlvNameModifier }}"
              NielsenId3NameModifier: "{{ NielsenId3NameModifier }}"
              Scte35NameModifier: "{{ Scte35NameModifier }}"
              Id3Behavior: "{{ Id3Behavior }}"
              Id3NameModifier: "{{ Id3NameModifier }}"
              CaptionLanguageMappings:
                - CaptionChannel: {{ CaptionChannel }}
                  LanguageCode: "{{ LanguageCode }}"
              TimedMetadataId3Frame: "{{ TimedMetadataId3Frame }}"
              TimedMetadataId3Period: {{ TimedMetadataId3Period }}
              TimedMetadataPassthrough: "{{ TimedMetadataPassthrough }}"
              AdditionalDestinations:
                - Destination:
                    DestinationRefId: "{{ DestinationRefId }}"
            SrtGroupSettings:
              InputLossAction: "{{ InputLossAction }}"
            MediaConnectRouterGroupSettings:
              AvailabilityZones:
                - "{{ AvailabilityZones }}"
          Outputs: "{{ Outputs }}"
      TimecodeConfig:
        Source: "{{ Source }}"
        SyncThreshold: {{ SyncThreshold }}
      VideoDescriptions:
        - CodecSettings:
            FrameCaptureSettings:
              CaptureInterval: {{ CaptureInterval }}
              CaptureIntervalUnits: "{{ CaptureIntervalUnits }}"
              TimecodeBurninSettings:
                FontSize: "{{ FontSize }}"
                Position: "{{ Position }}"
                Prefix: "{{ Prefix }}"
            H264Settings:
              AdaptiveQuantization: "{{ AdaptiveQuantization }}"
              AfdSignaling: "{{ AfdSignaling }}"
              Bitrate: {{ Bitrate }}
              BufFillPct: {{ BufFillPct }}
              BufSize: {{ BufSize }}
              ColorMetadata: "{{ ColorMetadata }}"
              ColorSpaceSettings:
                ColorSpacePassthroughSettings: "{{ ColorSpacePassthroughSettings }}"
                Rec601Settings: "{{ Rec601Settings }}"
                Rec709Settings: "{{ Rec709Settings }}"
              EntropyEncoding: "{{ EntropyEncoding }}"
              FilterSettings:
                TemporalFilterSettings: "{{ TemporalFilterSettings }}"
                BandwidthReductionFilterSettings: "{{ BandwidthReductionFilterSettings }}"
              FixedAfd: "{{ FixedAfd }}"
              FlickerAq: "{{ FlickerAq }}"
              ForceFieldPictures: "{{ ForceFieldPictures }}"
              FramerateControl: "{{ FramerateControl }}"
              FramerateDenominator: {{ FramerateDenominator }}
              FramerateNumerator: {{ FramerateNumerator }}
              GopBReference: "{{ GopBReference }}"
              GopClosedCadence: {{ GopClosedCadence }}
              GopNumBFrames: {{ GopNumBFrames }}
              GopSize: {{ GopSize }}
              GopSizeUnits: "{{ GopSizeUnits }}"
              Level: "{{ Level }}"
              LookAheadRateControl: "{{ LookAheadRateControl }}"
              MaxBitrate: {{ MaxBitrate }}
              MinIInterval: {{ MinIInterval }}
              NumRefFrames: {{ NumRefFrames }}
              ParControl: "{{ ParControl }}"
              ParDenominator: {{ ParDenominator }}
              ParNumerator: {{ ParNumerator }}
              Profile: "{{ Profile }}"
              QualityLevel: "{{ QualityLevel }}"
              QvbrQualityLevel: {{ QvbrQualityLevel }}
              RateControlMode: "{{ RateControlMode }}"
              ScanType: "{{ ScanType }}"
              SceneChangeDetect: "{{ SceneChangeDetect }}"
              Slices: {{ Slices }}
              Softness: {{ Softness }}
              SpatialAq: "{{ SpatialAq }}"
              SubgopLength: "{{ SubgopLength }}"
              Syntax: "{{ Syntax }}"
              TemporalAq: "{{ TemporalAq }}"
              TimecodeInsertion: "{{ TimecodeInsertion }}"
              TimecodeBurninSettings:
                FontSize: "{{ FontSize }}"
                Position: "{{ Position }}"
                Prefix: "{{ Prefix }}"
              MinQp: {{ MinQp }}
              MinBitrate: {{ MinBitrate }}
            H265Settings:
              AdaptiveQuantization: "{{ AdaptiveQuantization }}"
              AfdSignaling: "{{ AfdSignaling }}"
              AlternativeTransferFunction: "{{ AlternativeTransferFunction }}"
              Bitrate: {{ Bitrate }}
              BufSize: {{ BufSize }}
              ColorMetadata: "{{ ColorMetadata }}"
              ColorSpaceSettings:
                ColorSpacePassthroughSettings: "{{ ColorSpacePassthroughSettings }}"
                DolbyVision81Settings: "{{ DolbyVision81Settings }}"
                Hdr10Settings: "{{ Hdr10Settings }}"
                Rec601Settings: "{{ Rec601Settings }}"
                Rec709Settings: "{{ Rec709Settings }}"
                Hlg2020Settings: "{{ Hlg2020Settings }}"
              FilterSettings:
                TemporalFilterSettings: "{{ TemporalFilterSettings }}"
                BandwidthReductionFilterSettings: "{{ BandwidthReductionFilterSettings }}"
              FixedAfd: "{{ FixedAfd }}"
              FlickerAq: "{{ FlickerAq }}"
              FramerateDenominator: {{ FramerateDenominator }}
              FramerateNumerator: {{ FramerateNumerator }}
              GopClosedCadence: {{ GopClosedCadence }}
              GopSize: {{ GopSize }}
              GopSizeUnits: "{{ GopSizeUnits }}"
              Level: "{{ Level }}"
              LookAheadRateControl: "{{ LookAheadRateControl }}"
              MaxBitrate: {{ MaxBitrate }}
              MinIInterval: {{ MinIInterval }}
              ParDenominator: {{ ParDenominator }}
              ParNumerator: {{ ParNumerator }}
              Profile: "{{ Profile }}"
              QvbrQualityLevel: {{ QvbrQualityLevel }}
              RateControlMode: "{{ RateControlMode }}"
              ScanType: "{{ ScanType }}"
              SceneChangeDetect: "{{ SceneChangeDetect }}"
              Slices: {{ Slices }}
              Tier: "{{ Tier }}"
              TimecodeInsertion: "{{ TimecodeInsertion }}"
              TimecodeBurninSettings:
                FontSize: "{{ FontSize }}"
                Position: "{{ Position }}"
                Prefix: "{{ Prefix }}"
              MvOverPictureBoundaries: "{{ MvOverPictureBoundaries }}"
              MvTemporalPredictor: "{{ MvTemporalPredictor }}"
              TileHeight: {{ TileHeight }}
              TilePadding: "{{ TilePadding }}"
              TileWidth: {{ TileWidth }}
              TreeblockSize: "{{ TreeblockSize }}"
              MinQp: {{ MinQp }}
              Deblocking: "{{ Deblocking }}"
              GopBReference: "{{ GopBReference }}"
              GopNumBFrames: {{ GopNumBFrames }}
              MinBitrate: {{ MinBitrate }}
              SubgopLength: "{{ SubgopLength }}"
            Mpeg2Settings:
              AdaptiveQuantization: "{{ AdaptiveQuantization }}"
              AfdSignaling: "{{ AfdSignaling }}"
              ColorMetadata: "{{ ColorMetadata }}"
              ColorSpace: "{{ ColorSpace }}"
              DisplayAspectRatio: "{{ DisplayAspectRatio }}"
              FilterSettings:
                TemporalFilterSettings: "{{ TemporalFilterSettings }}"
              FixedAfd: "{{ FixedAfd }}"
              FramerateDenominator: {{ FramerateDenominator }}
              FramerateNumerator: {{ FramerateNumerator }}
              GopClosedCadence: {{ GopClosedCadence }}
              GopNumBFrames: {{ GopNumBFrames }}
              GopSize: {{ GopSize }}
              GopSizeUnits: "{{ GopSizeUnits }}"
              ScanType: "{{ ScanType }}"
              SubgopLength: "{{ SubgopLength }}"
              TimecodeInsertion: "{{ TimecodeInsertion }}"
              TimecodeBurninSettings:
                FontSize: "{{ FontSize }}"
                Position: "{{ Position }}"
                Prefix: "{{ Prefix }}"
            Av1Settings:
              AfdSignaling: "{{ AfdSignaling }}"
              BufSize: {{ BufSize }}
              ColorSpaceSettings:
                ColorSpacePassthroughSettings: "{{ ColorSpacePassthroughSettings }}"
                Hdr10Settings: "{{ Hdr10Settings }}"
                Rec601Settings: "{{ Rec601Settings }}"
                Rec709Settings: "{{ Rec709Settings }}"
                Hlg2020Settings: "{{ Hlg2020Settings }}"
              FixedAfd: "{{ FixedAfd }}"
              FramerateDenominator: {{ FramerateDenominator }}
              FramerateNumerator: {{ FramerateNumerator }}
              GopSize: {{ GopSize }}
              GopSizeUnits: "{{ GopSizeUnits }}"
              Level: "{{ Level }}"
              LookAheadRateControl: "{{ LookAheadRateControl }}"
              MaxBitrate: {{ MaxBitrate }}
              MinIInterval: {{ MinIInterval }}
              ParDenominator: {{ ParDenominator }}
              ParNumerator: {{ ParNumerator }}
              QvbrQualityLevel: {{ QvbrQualityLevel }}
              SceneChangeDetect: "{{ SceneChangeDetect }}"
              TimecodeBurninSettings:
                FontSize: "{{ FontSize }}"
                Position: "{{ Position }}"
                Prefix: "{{ Prefix }}"
              Bitrate: {{ Bitrate }}
              RateControlMode: "{{ RateControlMode }}"
              MinBitrate: {{ MinBitrate }}
              SpatialAq: "{{ SpatialAq }}"
              TemporalAq: "{{ TemporalAq }}"
              TimecodeInsertion: "{{ TimecodeInsertion }}"
              BitDepth: "{{ BitDepth }}"
          Height: {{ Height }}
          Name: "{{ Name }}"
          RespondToAfd: "{{ RespondToAfd }}"
          ScalingBehavior: "{{ ScalingBehavior }}"
          Sharpness: {{ Sharpness }}
          Width: {{ Width }}
          CropRectangle:
            Height: {{ Height }}
            Width: {{ Width }}
            X: {{ X }}
            Y: {{ Y }}
          OutputPositionRectangle:
            Height: {{ Height }}
            Width: {{ Width }}
            X: {{ X }}
            Y: {{ Y }}
      ThumbnailConfiguration:
        State: "{{ State }}"
      ColorCorrectionSettings:
        GlobalColorCorrections:
          - InputColorSpace: "{{ InputColorSpace }}"
            OutputColorSpace: "{{ OutputColorSpace }}"
            Uri: "{{ Uri }}"
  - name: InputAttachments
    description: |
      Placeholder documentation for __listOfInputAttachment
    value:
      - AutomaticInputFailoverSettings:
          ErrorClearTimeMsec: {{ ErrorClearTimeMsec }}
          FailoverConditions:
            - FailoverConditionSettings:
                AudioSilenceSettings:
                  AudioSelectorName: "{{ AudioSelectorName }}"
                  AudioSilenceThresholdMsec: {{ AudioSilenceThresholdMsec }}
                InputLossSettings:
                  InputLossThresholdMsec: {{ InputLossThresholdMsec }}
                VideoBlackSettings:
                  BlackDetectThreshold: {{ BlackDetectThreshold }}
                  VideoBlackThresholdMsec: {{ VideoBlackThresholdMsec }}
          InputPreference: "{{ InputPreference }}"
          SecondaryInputId: "{{ SecondaryInputId }}"
        InputAttachmentName: "{{ InputAttachmentName }}"
        InputId: "{{ InputId }}"
        InputSettings:
          AudioSelectors:
            - Name: "{{ Name }}"
              SelectorSettings:
                AudioHlsRenditionSelection:
                  GroupId: "{{ GroupId }}"
                  Name: "{{ Name }}"
                AudioLanguageSelection:
                  LanguageCode: "{{ LanguageCode }}"
                  LanguageSelectionPolicy: "{{ LanguageSelectionPolicy }}"
                AudioPidSelection:
                  Pid: {{ Pid }}
                  Pids: "{{ Pids }}"
                AudioTrackSelection:
                  Tracks: "{{ Tracks }}"
                  DolbyEDecode: "{{ DolbyEDecode }}"
          CaptionSelectors:
            - LanguageCode: "{{ LanguageCode }}"
              Name: "{{ Name }}"
              SelectorSettings:
                AncillarySourceSettings:
                  SourceAncillaryChannelNumber: {{ SourceAncillaryChannelNumber }}
                AribSourceSettings: "{{ AribSourceSettings }}"
                DvbSubSourceSettings:
                  OcrLanguage: "{{ OcrLanguage }}"
                  Pid: {{ Pid }}
                EmbeddedSourceSettings:
                  Convert608To708: "{{ Convert608To708 }}"
                  Scte20Detection: "{{ Scte20Detection }}"
                  Source608ChannelNumber: {{ Source608ChannelNumber }}
                  Source608TrackNumber: {{ Source608TrackNumber }}
                Scte20SourceSettings:
                  Convert608To708: "{{ Convert608To708 }}"
                  Source608ChannelNumber: {{ Source608ChannelNumber }}
                Scte27SourceSettings:
                  OcrLanguage: "{{ OcrLanguage }}"
                  Pid: {{ Pid }}
                TeletextSourceSettings:
                  OutputRectangle: "{{ OutputRectangle }}"
                  PageNumber: "{{ PageNumber }}"
                SmartSubtitleSourceSettings:
                  CaptionSynchronizationMode: "{{ CaptionSynchronizationMode }}"
                  InferenceFeedOutput: "{{ InferenceFeedOutput }}"
          DeblockFilter: "{{ DeblockFilter }}"
          DenoiseFilter: "{{ DenoiseFilter }}"
          FilterStrength: {{ FilterStrength }}
          InputFilter: "{{ InputFilter }}"
          NetworkInputSettings:
            HlsInputSettings:
              Bandwidth: {{ Bandwidth }}
              BufferSegments: {{ BufferSegments }}
              Retries: {{ Retries }}
              RetryInterval: {{ RetryInterval }}
              Scte35Source: "{{ Scte35Source }}"
            ServerValidation: "{{ ServerValidation }}"
            MulticastInputSettings:
              SourceIpAddress: "{{ SourceIpAddress }}"
          Scte35Pid: {{ Scte35Pid }}
          Smpte2038DataPreference: "{{ Smpte2038DataPreference }}"
          SourceEndBehavior: "{{ SourceEndBehavior }}"
          VideoSelector:
            ColorSpace: "{{ ColorSpace }}"
            ColorSpaceSettings:
              Hdr10Settings:
                MaxCll: {{ MaxCll }}
                MaxFall: {{ MaxFall }}
            ColorSpaceUsage: "{{ ColorSpaceUsage }}"
            SelectorSettings:
              VideoSelectorPid:
                Pid: {{ Pid }}
              VideoSelectorProgramId:
                ProgramId: {{ ProgramId }}
        LogicalInterfaceNames: "{{ LogicalInterfaceNames }}"
  - name: InputSpecification
    description: |
      Placeholder documentation for InputSpecification
    value:
      Codec: "{{ Codec }}"
      MaximumBitrate: "{{ MaximumBitrate }}"
      Resolution: "{{ Resolution }}"
  - name: LogLevel
    value: "{{ LogLevel }}"
    description: |
      The log level the user wants for their channel.
    valid_values: ['ERROR', 'WARNING', 'INFO', 'DEBUG', 'DISABLED']
  - name: Maintenance
    description: |
      Placeholder documentation for MaintenanceCreateSettings
    value:
      MaintenanceDay: "{{ MaintenanceDay }}"
      MaintenanceStartTime: "{{ MaintenanceStartTime }}"
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __string
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string
  - name: Reserved
    value: "{{ Reserved }}"
    description: |
      Placeholder documentation for __string
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      Placeholder documentation for __string
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags
  - name: Vpc
    description: |
      The properties for a private VPC Output When this property is specified, the output egress addresses will be created in a user specified VPC
    value:
      PublicAddressAllocationIds:
        - "{{ PublicAddressAllocationIds }}"
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"
      SubnetIds:
        - "{{ SubnetIds }}"
  - name: AnywhereSettings
    description: |
      Elemental anywhere settings
    value:
      ChannelPlacementGroupId: "{{ ChannelPlacementGroupId }}"
      ClusterId: "{{ ClusterId }}"
  - name: ChannelEngineVersion
    description: |
      Placeholder documentation for ChannelEngineVersionRequest
    value:
      Version: "{{ Version }}"
  - name: DryRun
    value: {{ DryRun }}
    description: |
      Placeholder documentation for __boolean
  - name: LinkedChannelSettings
    description: |
      Configuration for linked channel relationships
    value:
      FollowerChannelSettings:
        LinkedChannelType: "{{ LinkedChannelType }}"
        PrimaryChannelArn: "{{ PrimaryChannelArn }}"
      PrimaryChannelSettings:
        LinkedChannelType: "{{ LinkedChannelType }}"
  - name: ChannelSecurityGroups
    value:
      - "{{ ChannelSecurityGroups }}"
    description: |
      Placeholder documentation for __listOf__string
  - name: InferenceSettings
    description: |
      Configures Elemental Inference features in a channel.
    value:
      FeedArn: "{{ FeedArn }}"
      AudioFeedInputs:
        - AudioSelectorName: "{{ AudioSelectorName }}"
          FeedInput: "{{ FeedInput }}"

UPDATE examples

update_channel_class

Changes the class of the channel.

UPDATE aws.medialive.channels
SET 
ChannelClass = '{{ ChannelClass }}',
Destinations = '{{ Destinations }}'
WHERE 
channel_id = '{{ channel_id }}' --required
AND region = '{{ region }}' --required
AND ChannelClass = '{{ ChannelClass }}' --required
RETURNING
channel;

update_channel

Updates a channel.

UPDATE aws.medialive.channels
SET 
CdiInputSpecification = '{{ CdiInputSpecification }}',
Destinations = '{{ Destinations }}',
EncoderSettings = '{{ EncoderSettings }}',
InputAttachments = '{{ InputAttachments }}',
InputSpecification = '{{ InputSpecification }}',
LogLevel = '{{ LogLevel }}',
Maintenance = '{{ Maintenance }}',
Name = '{{ Name }}',
RoleArn = '{{ RoleArn }}',
ChannelEngineVersion = '{{ ChannelEngineVersion }}',
DryRun = {{ DryRun }},
AnywhereSettings = '{{ AnywhereSettings }}',
LinkedChannelSettings = '{{ LinkedChannelSettings }}',
ChannelSecurityGroups = '{{ ChannelSecurityGroups }}',
InferenceSettings = '{{ InferenceSettings }}',
SpecialRouterSettings = '{{ SpecialRouterSettings }}'
WHERE 
channel_id = '{{ channel_id }}' --required
AND region = '{{ region }}' --required
RETURNING
channel;

DELETE examples

delete_channel

Starts deletion of channel. The associated outputs are also deleted.

DELETE FROM aws.medialive.channels
WHERE channel_id = '{{ channel_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

batch_update_schedule

Update a channel schedule

EXEC aws.medialive.channels.batch_update_schedule 
@channel_id='{{ channel_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Creates": "{{ Creates }}", 
"Deletes": "{{ Deletes }}"
}'
;

restart_channel_pipelines

Restart pipelines in one channel that is currently running.

EXEC aws.medialive.channels.restart_channel_pipelines 
@channel_id='{{ channel_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"PipelineIds": "{{ PipelineIds }}"
}'
;

start_channel

Starts an existing channel

EXEC aws.medialive.channels.start_channel 
@channel_id='{{ channel_id }}' --required, 
@region='{{ region }}' --required
;

stop_channel

Stops a running channel

EXEC aws.medialive.channels.stop_channel 
@channel_id='{{ channel_id }}' --required, 
@region='{{ region }}' --required
;