As Run log for Channel Assembly - AWS Elemental MediaTailor

As Run log for Channel Assembly

The As Run log, in the CloudWatch MediaTailor/Channel/AsRunLog log group, shows information about programs and ad breaks as they play.

When you create a channel, the As Run log is disabled by default. Using the Console or the AWS Command Line Interface (AWS CLI), you can enable and disable the As Run log state for each channel in your account.

When you enable the As Run log, MediaTailor automatically creates a service-linked role that allows MediaTailor to write and manage the As Run log in your CloudWatch Logs account. For more information about service-linked roles, see Using service-linked roles for MediaTailor.

Note

The As Run Log currently only supports the default program. For now it doesn't support the alternateMedia created by program rules. This means that it currently does not generate the As Run Log for alternateMedia.

Enabling the As Run log

To enable the As Run log, specify the channel name and enable the As Run log type for that channel.

Console
To enable the As Run log when creating a channel
  1. Sign in to the AWS Management Console and open the MediaTailor console at https://console.aws.amazon.com/mediatailor/.

  2. In the navigation pane, choose Channel assembly > Channels.

  3. On the navigation bar, choose Create channel.

  4. In the Set channel details, Configure outputs, and Access control panes, configure your channel as desired.

  5. In the Access control pane, choose Next.

  6. In the Logging pane, under Log types, select Enable as run to enable the As Run log.

To enable the As Run log when updating a channel
Note

If the channel is currently running, you must first stop that channel before you can update it. After you stop the channel, you can choose Actions > Edit to begin updating the channel.

  1. Sign in to the AWS Management Console and open the MediaTailor console at https://console.aws.amazon.com/mediatailor/.

  2. In the navigation pane, choose Channel assembly > Channels.

  3. Choose the channel that you want to update to enable the As Run log for.

  4. Choose Actions > Edit.

  5. In the Set channel details, Configure outputs, and Access control panes, update your channel configuration as desired.

  6. In the Access control pane, choose Next.

  7. In the Logging pane, under Log types, select Enable as run to enable the As Run log.

To enable the As Run log from the Logging tab
Note

If the channel is currently running, you must use the Logging tab instead of choosing Actions > Edit to enable the As Run log.

  1. Sign in to the AWS Management Console and open the MediaTailor console at https://console.aws.amazon.com/mediatailor/.

  2. In the navigation pane, choose Channel assembly > Channels.

  3. Choose the channel that you want to enable the As Run log for.

  4. In the navigation bar under the channel's name, choose Logging.

  5. Under Logging > Log types, select As run to enable the As Run log.

AWS Command Line Interface (AWS CLI)

To enable the As Run log

Run the configure-logs-for-channel command and specify the appropriate values for the required parameters.

This example is formatted for Linux, macOS, or Unix, and it uses the backslash (\) line-continuation character to improve readability.

$ aws mediatailor configure-logs-for-channel \ --channel-name MyChannel \ --log-types AS_RUN

This example is formatted for Microsoft Windows, and it uses the caret (^) line-continuation character to improve readability.

C:\> aws mediatailor configure-logs-for-channel ^ --channel-name MyChannel ^ --log-types AS_RUN

Where:

  • MyChannel is the name of the channel that you own and want to enable the As Run log for.

If the command runs successfully, you receive output similar to the following.

{ "ChannelName": "MyChannel", "LogTypes": [ "AS_RUN" ] }

Disabling the As Run log

To disable the As Run log for a channel that has it enabled, specify the channel name and disable the As Run log type for that channel.

Console
To disable the As Run log when updating a channel
Note

If the channel is currently running, you must first stop that channel before you can update it. After you stop the channel, you can choose Actions > Edit to begin updating the channel.

  1. Sign in to the AWS Management Console and open the MediaTailor console at https://console.aws.amazon.com/mediatailor/.

  2. In the navigation pane, choose Channel assembly > Channels.

  3. Choose the channel that you want to update to enable the As Run log for.

  4. Choose Actions > Edit.

  5. In the Set channel details, Configure outputs, and Access control panes, update your channel configuration as desired.

  6. In the Access control pane, choose Next.

  7. In the Logging pane, under Log types, clear Enable as run to disable the As Run log.

To disable the As Run log from the Logging tab
Note

If the channel is currently running, you must use the Logging tab instead of choosing Actions > Edit to disable the As Run log.

  1. Sign in to the AWS Management Console and open the MediaTailor console at https://console.aws.amazon.com/mediatailor/.

  2. In the navigation pane, choose Channel assembly > Channels.

  3. Choose the channel that you want to disable the As Run log for.

  4. In the navigation bar under the channel's name, choose Loging.

  5. Under Logging > Log types, clear As run to disable the As Run log.

AWS Command Line Interface (AWS CLI)

To disable the As Run log

Run the configure-logs-for-channel command and specify the appropriate values for the required parameters.

This example is formatted for Linux, macOS, or Unix, and it uses the backslash (\) line-continuation character to improve readability.

$ aws mediatailor configure-logs-for-channel \ --channel-name MyChannel \ --log-types

This example is formatted for Microsoft Windows, and it uses the caret (^) line-continuation character to improve readability.

C:\> aws mediatailor configure-logs-for-channel ^ --channel-name MyChannel ^ --log-types

Where:

  • MyChannel is the name of the channel that you own and want to disable the As Run log for.

If the command runs successfully, you receive output similar to the following.

{ "ChannelName": "MyChannel", "LogTypes": [] }