describe_schedule

describe_schedule(**kwargs)

Get a channel schedule

See also: AWS API Documentation

Request Syntax

response = client.describe_schedule(
    ChannelId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• ChannelId (string) -- [REQUIRED] Id of the channel whose schedule is being updated.
• MaxResults (integer) -- Placeholder documentation for MaxResults
• NextToken (string) -- Placeholder documentation for __string

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ScheduleActions': [
        {
            'ActionName': 'string',
            'ScheduleActionSettings': {
                'HlsId3SegmentTaggingSettings': {
                    'Tag': 'string'
                },
                'HlsTimedMetadataSettings': {
                    'Id3': 'string'
                },
                'InputPrepareSettings': {
                    'InputAttachmentNameReference': 'string',
                    'InputClippingSettings': {
                        'InputTimecodeSource': 'ZEROBASED'|'EMBEDDED',
                        'StartTimecode': {
                            'Timecode': 'string'
                        },
                        'StopTimecode': {
                            'LastFrameClippingBehavior': 'EXCLUDE_LAST_FRAME'|'INCLUDE_LAST_FRAME',
                            'Timecode': 'string'
                        }
                    },
                    'UrlPath': [
                        'string',
                    ]
                },
                'InputSwitchSettings': {
                    'InputAttachmentNameReference': 'string',
                    'InputClippingSettings': {
                        'InputTimecodeSource': 'ZEROBASED'|'EMBEDDED',
                        'StartTimecode': {
                            'Timecode': 'string'
                        },
                        'StopTimecode': {
                            'LastFrameClippingBehavior': 'EXCLUDE_LAST_FRAME'|'INCLUDE_LAST_FRAME',
                            'Timecode': 'string'
                        }
                    },
                    'UrlPath': [
                        'string',
                    ]
                },
                'MotionGraphicsImageActivateSettings': {
                    'Duration': 123,
                    'PasswordParam': 'string',
                    'Url': 'string',
                    'Username': 'string'
                },
                'MotionGraphicsImageDeactivateSettings': {},
                'PauseStateSettings': {
                    'Pipelines': [
                        {
                            'PipelineId': 'PIPELINE_0'|'PIPELINE_1'
                        },
                    ]
                },
                'Scte35InputSettings': {
                    'InputAttachmentNameReference': 'string',
                    'Mode': 'FIXED'|'FOLLOW_ACTIVE'
                },
                'Scte35ReturnToNetworkSettings': {
                    'SpliceEventId': 123
                },
                'Scte35SpliceInsertSettings': {
                    'Duration': 123,
                    'SpliceEventId': 123
                },
                'Scte35TimeSignalSettings': {
                    'Scte35Descriptors': [
                        {
                            'Scte35DescriptorSettings': {
                                'SegmentationDescriptorScte35DescriptorSettings': {
                                    'DeliveryRestrictions': {
                                        'ArchiveAllowedFlag': 'ARCHIVE_NOT_ALLOWED'|'ARCHIVE_ALLOWED',
                                        'DeviceRestrictions': 'NONE'|'RESTRICT_GROUP0'|'RESTRICT_GROUP1'|'RESTRICT_GROUP2',
                                        'NoRegionalBlackoutFlag': 'REGIONAL_BLACKOUT'|'NO_REGIONAL_BLACKOUT',
                                        'WebDeliveryAllowedFlag': 'WEB_DELIVERY_NOT_ALLOWED'|'WEB_DELIVERY_ALLOWED'
                                    },
                                    'SegmentNum': 123,
                                    'SegmentationCancelIndicator': 'SEGMENTATION_EVENT_NOT_CANCELED'|'SEGMENTATION_EVENT_CANCELED',
                                    'SegmentationDuration': 123,
                                    'SegmentationEventId': 123,
                                    'SegmentationTypeId': 123,
                                    'SegmentationUpid': 'string',
                                    'SegmentationUpidType': 123,
                                    'SegmentsExpected': 123,
                                    'SubSegmentNum': 123,
                                    'SubSegmentsExpected': 123
                                }
                            }
                        },
                    ]
                },
                'StaticImageActivateSettings': {
                    'Duration': 123,
                    'FadeIn': 123,
                    'FadeOut': 123,
                    'Height': 123,
                    'Image': {
                        'PasswordParam': 'string',
                        'Uri': 'string',
                        'Username': 'string'
                    },
                    'ImageX': 123,
                    'ImageY': 123,
                    'Layer': 123,
                    'Opacity': 123,
                    'Width': 123
                },
                'StaticImageDeactivateSettings': {
                    'FadeOut': 123,
                    'Layer': 123
                }
            },
            'ScheduleActionStartSettings': {
                'FixedModeScheduleActionStartSettings': {
                    'Time': 'string'
                },
                'FollowModeScheduleActionStartSettings': {
                    'FollowPoint': 'END'|'START',
                    'ReferenceActionName': 'string'
                },
                'ImmediateModeScheduleActionStartSettings': {}
            }
        },
    ]
}

Response Structure

• (dict) -- An array of channel schedule actions.
  • NextToken (string) -- The next token; for use in pagination.
  • ScheduleActions (list) -- The list of actions in the schedule.
    • (dict) -- Contains information on a single schedule action.
      • ActionName (string) -- The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.
      • ScheduleActionSettings (dict) -- Settings for this schedule action.
        • HlsId3SegmentTaggingSettings (dict) -- Action to insert HLS ID3 segment tagging
          • Tag (string) -- ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html
        • HlsTimedMetadataSettings (dict) -- Action to insert HLS metadata
          • Id3 (string) -- Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure
        • InputPrepareSettings (dict) -- Action to prepare an input for a future immediate input switch
          • InputAttachmentNameReference (string) -- The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated.
          • InputClippingSettings (dict) -- Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.
            • InputTimecodeSource (string) -- The source of the timecodes in the source being clipped.
            • StartTimecode (dict) -- Settings to identify the start of the clip.
              • Timecode (string) -- The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
            • StopTimecode (dict) -- Settings to identify the end of the clip.
              • LastFrameClippingBehavior (string) -- If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.
              • Timecode (string) -- The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
          • UrlPath (list) -- The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.
            • (string) -- Placeholder documentation for __string
        • InputSwitchSettings (dict) -- Action to switch the input
          • InputAttachmentNameReference (string) -- The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration.
          • InputClippingSettings (dict) -- Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.
            • InputTimecodeSource (string) -- The source of the timecodes in the source being clipped.
            • StartTimecode (dict) -- Settings to identify the start of the clip.
              • Timecode (string) -- The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
            • StopTimecode (dict) -- Settings to identify the end of the clip.
              • LastFrameClippingBehavior (string) -- If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.
              • Timecode (string) -- The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
          • UrlPath (list) -- The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.
            • (string) -- Placeholder documentation for __string
        • MotionGraphicsImageActivateSettings (dict) -- Action to activate a motion graphics image overlay
          • Duration (integer) -- Duration (in milliseconds) that motion graphics should render on to the video stream. Leaving out this property or setting to 0 will result in rendering continuing until a deactivate action is processed.
          • PasswordParam (string) -- Key used to extract the password from EC2 Parameter store
          • Url (string) -- URI of the HTML5 content to be rendered into the live stream.
          • Username (string) -- Documentation update needed
        • MotionGraphicsImageDeactivateSettings (dict) -- Action to deactivate a motion graphics image overlay
        • PauseStateSettings (dict) -- Action to pause or unpause one or both channel pipelines
          • Pipelines (list) -- Placeholder documentation for __listOfPipelinePauseStateSettings
            • (dict) -- Settings for pausing a pipeline.
              • PipelineId (string) -- Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").
        • Scte35InputSettings (dict) -- Action to specify scte35 input
          • InputAttachmentNameReference (string) -- In fixed mode, enter the name of the input attachment that you want to use as a SCTE-35 input. (Don't enter the ID of the input.)"
          • Mode (string) -- Whether the SCTE-35 input should be the active input or a fixed input.
        • Scte35ReturnToNetworkSettings (dict) -- Action to insert SCTE-35 return_to_network message
          • SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
        • Scte35SpliceInsertSettings (dict) -- Action to insert SCTE-35 splice_insert message
          • Duration (integer) -- Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.
          • SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
        • Scte35TimeSignalSettings (dict) -- Action to insert SCTE-35 time_signal message
          • Scte35Descriptors (list) -- The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
            • (dict) -- Holds one set of SCTE-35 Descriptor Settings.
              • Scte35DescriptorSettings (dict) -- SCTE-35 Descriptor Settings.
                • SegmentationDescriptorScte35DescriptorSettings (dict) -- SCTE-35 Segmentation Descriptor.
                  • DeliveryRestrictions (dict) -- Holds the four SCTE-35 delivery restriction parameters.
                    • ArchiveAllowedFlag (string) -- Corresponds to SCTE-35 archive_allowed_flag.
                    • DeviceRestrictions (string) -- Corresponds to SCTE-35 device_restrictions parameter.
                    • NoRegionalBlackoutFlag (string) -- Corresponds to SCTE-35 no_regional_blackout_flag parameter.
                    • WebDeliveryAllowedFlag (string) -- Corresponds to SCTE-35 web_delivery_allowed_flag parameter.
                  • SegmentNum (integer) -- Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
                  • SegmentationCancelIndicator (string) -- Corresponds to SCTE-35 segmentation_event_cancel_indicator.
                  • SegmentationDuration (integer) -- Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.
                  • SegmentationEventId (integer) -- Corresponds to SCTE-35 segmentation_event_id.
                  • SegmentationTypeId (integer) -- Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").
                  • SegmentationUpid (string) -- Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.
                  • SegmentationUpidType (integer) -- Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").
                  • SegmentsExpected (integer) -- Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
                  • SubSegmentNum (integer) -- Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
                  • SubSegmentsExpected (integer) -- Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
        • StaticImageActivateSettings (dict) -- Action to activate a static image overlay
          • Duration (integer) -- The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.
          • FadeIn (integer) -- The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).
          • FadeOut (integer) -- Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).
          • Height (integer) -- The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.
          • Image (dict) -- The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.
            • PasswordParam (string) -- key used to extract the password from EC2 Parameter store
            • Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username (string) -- Documentation update needed
          • ImageX (integer) -- Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.
          • ImageY (integer) -- Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.
          • Layer (integer) -- The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.
          • Opacity (integer) -- Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
          • Width (integer) -- The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
        • StaticImageDeactivateSettings (dict) -- Action to deactivate a static image overlay
          • FadeOut (integer) -- The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
          • Layer (integer) -- The image overlay layer to deactivate, 0 to 7. Default is 0.
      • ScheduleActionStartSettings (dict) -- The time for the action to start in the channel.
        • FixedModeScheduleActionStartSettings (dict) -- Option for specifying the start time for an action.
          • Time (string) -- Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".
        • FollowModeScheduleActionStartSettings (dict) -- Option for specifying an action as relative to another action.
          • FollowPoint (string) -- Identifies whether this action starts relative to the start or relative to the end of the reference action.
          • ReferenceActionName (string) -- The action name of another action that this one refers to.
        • ImmediateModeScheduleActionStartSettings (dict) -- Option for specifying an action that should be applied immediately.

Exceptions

• MediaLive.Client.exceptions.BadRequestException
• MediaLive.Client.exceptions.InternalServerErrorException
• MediaLive.Client.exceptions.ForbiddenException
• MediaLive.Client.exceptions.BadGatewayException
• MediaLive.Client.exceptions.NotFoundException
• MediaLive.Client.exceptions.GatewayTimeoutException
• MediaLive.Client.exceptions.TooManyRequestsException