AWS API Changes

2018/08/23 - AWS Elemental MediaLive - 2 new api methods

Changes Update medialive client to latest version

BatchUpdateSchedule (new)

Link ¶

Update a channel schedule

Request Syntax

client.batch_update_schedule(
    ChannelId='string',
    Creates={
        'ScheduleActions': [
            {
                'ActionName': 'string',
                'ScheduleActionSettings': {
                    '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'
                    }
                }
            },
        ]
    },
    Deletes={
        'ActionNames': [
            'string',
        ]
    }
)

type ChannelId:

string

param ChannelId:

[REQUIRED] Id of the channel whose schedule is being updated.

type Creates:

dict

param Creates:

Schedule actions to create in the schedule.

ScheduleActions (list) -- [REQUIRED] A list of schedule actions to create.
- (dict) -- A single schedule action.
  - ActionName (string) -- [REQUIRED] The name of the action, must be unique within the schedule.
  - ScheduleActionSettings (dict) -- [REQUIRED] Settings for this schedule action.
    - Scte35ReturnToNetworkSettings (dict) -- SCTE-35 Return to Network Settings
      - SpliceEventId (integer) -- [REQUIRED] The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
    - Scte35SpliceInsertSettings (dict) -- SCTE-35 Splice Insert Settings
      - Duration (integer) -- The duration for the SCTE-35 splice_insert specified in 90KHz clock ticks. When duration is not specified the expectation is that a Scte35ReturnToNetwork action will be scheduled.
      - SpliceEventId (integer) -- [REQUIRED] The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
    - Scte35TimeSignalSettings (dict) -- SCTE-35 Time Signal Settings
      - Scte35Descriptors (list) -- [REQUIRED] The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
        
        (dict) -- SCTE-35 Descriptor.
        
        Scte35DescriptorSettings (dict) -- [REQUIRED] SCTE-35 Descriptor Settings.
        
        SegmentationDescriptorScte35DescriptorSettings (dict) -- [REQUIRED] SCTE-35 Segmentation Descriptor.
        
        DeliveryRestrictions (dict) -- SCTE-35 delivery restrictions.
        
        ArchiveAllowedFlag (string) -- [REQUIRED] SCTE-35 segmentation_descriptor archive_allowed_flag.
        
        DeviceRestrictions (string) -- [REQUIRED] SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        NoRegionalBlackoutFlag (string) -- [REQUIRED] SCTE-35 segmentation_descriptor no_regional_blackout_flag.
        
        WebDeliveryAllowedFlag (string) -- [REQUIRED] SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        SegmentNum (integer) -- SCTE-35 segmentation_descriptor segment_num.
        
        SegmentationCancelIndicator (string) -- [REQUIRED] SCTE-35 segmentation_descriptor segmentation_event_cancel_indicator.
        
        SegmentationDuration (integer) -- SCTE-35 segmentation_descriptor segmentation_duration specified in 90 KHz clock ticks.
        
        SegmentationEventId (integer) -- [REQUIRED] SCTE-35 segmentation_descriptor segmentation_event_id.
        
        SegmentationTypeId (integer) -- SCTE-35 segmentation_descriptor segmentation_type_id.
        
        SegmentationUpid (string) -- SCTE-35 segmentation_descriptor segmentation_upid as a hex string.
        
        SegmentationUpidType (integer) -- SCTE-35 segmentation_descriptor segmentation_upid_type.
        
        SegmentsExpected (integer) -- SCTE-35 segmentation_descriptor segments_expected.
        
        SubSegmentNum (integer) -- SCTE-35 segmentation_descriptor sub_segment_num.
        
        SubSegmentsExpected (integer) -- SCTE-35 segmentation_descriptor sub_segments_expected.
    - StaticImageActivateSettings (dict) -- Static Image Activate
      - Duration (integer) -- The duration in milliseconds for the image to remain in the video. If omitted or set to 0, duration is infinite and image will remain until explicitly deactivated.
      - FadeIn (integer) -- The time in milliseconds for the image to fade in. Defaults to 0.
      - FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
      - Height (integer) -- The height of the image when inserted into the video. Defaults to the native height of the image.
      - Image (dict) -- [REQUIRED] The image to overlay on the video. Must be a 32 bit BMP, PNG, or TGA file. Must not be larger than the input video.
        
        PasswordParam (string) -- key used to extract the password from EC2 Parameter store
        
        Uri (string) -- [REQUIRED] 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 image on the horizontal axis in pixels. 0 is the left edge of the frame. Defaults to 0.
      - ImageY (integer) -- Placement of the top edge of the image on the vertical axis in pixels. 0 is the top edge of the frame. Defaults to 0.
      - Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
      - Opacity (integer) -- Opacity of image where 0 is transparent and 100 is fully opaque. Defaults to 100.
      - Width (integer) -- The width of the image when inserted into the video. Defaults to the native width of the image.
    - StaticImageDeactivateSettings (dict) -- Static Image Deactivate
      - FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
      - Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
  - ScheduleActionStartSettings (dict) -- [REQUIRED] When the action takes effect.
    - FixedModeScheduleActionStartSettings (dict) -- Fixed timestamp action start. Conforms to ISO-8601.
      - Time (string) -- Fixed timestamp action start. Conforms to ISO-8601.

type Deletes:

dict

param Deletes:

Schedule actions to delete from the schedule.

ActionNames (list) -- [REQUIRED] A list of schedule actions to delete, identified by unique name.
- (string) -- Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'Creates': {
        'ScheduleActions': [
            {
                'ActionName': 'string',
                'ScheduleActionSettings': {
                    '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'
                    }
                }
            },
        ]
    },
    'Deletes': {
        'ScheduleActions': [
            {
                'ActionName': 'string',
                'ScheduleActionSettings': {
                    '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'
                    }
                }
            },
        ]
    }
}

Response Structure

(dict) -- Successful update of the schedule.
- Creates (dict) -- Schedule actions created in the schedule.
  - ScheduleActions (list) -- Returned list of created schedule actions.
    - (dict) -- A single schedule action.
      - ActionName (string) -- The name of the action, must be unique within the schedule.
      - ScheduleActionSettings (dict) -- Settings for this schedule action.
        
        Scte35ReturnToNetworkSettings (dict) -- SCTE-35 Return to Network Settings
        
        SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
        
        Scte35SpliceInsertSettings (dict) -- SCTE-35 Splice Insert Settings
        
        Duration (integer) -- The duration for the SCTE-35 splice_insert specified in 90KHz clock ticks. When duration is not specified the expectation is that a Scte35ReturnToNetwork action will be scheduled.
        
        SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
        
        Scte35TimeSignalSettings (dict) -- SCTE-35 Time Signal Settings
        
        Scte35Descriptors (list) -- The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
        
        (dict) -- SCTE-35 Descriptor.
        
        Scte35DescriptorSettings (dict) -- SCTE-35 Descriptor Settings.
        
        SegmentationDescriptorScte35DescriptorSettings (dict) -- SCTE-35 Segmentation Descriptor.
        
        DeliveryRestrictions (dict) -- SCTE-35 delivery restrictions.
        
        ArchiveAllowedFlag (string) -- SCTE-35 segmentation_descriptor archive_allowed_flag.
        
        DeviceRestrictions (string) -- SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        NoRegionalBlackoutFlag (string) -- SCTE-35 segmentation_descriptor no_regional_blackout_flag.
        
        WebDeliveryAllowedFlag (string) -- SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        SegmentNum (integer) -- SCTE-35 segmentation_descriptor segment_num.
        
        SegmentationCancelIndicator (string) -- SCTE-35 segmentation_descriptor segmentation_event_cancel_indicator.
        
        SegmentationDuration (integer) -- SCTE-35 segmentation_descriptor segmentation_duration specified in 90 KHz clock ticks.
        
        SegmentationEventId (integer) -- SCTE-35 segmentation_descriptor segmentation_event_id.
        
        SegmentationTypeId (integer) -- SCTE-35 segmentation_descriptor segmentation_type_id.
        
        SegmentationUpid (string) -- SCTE-35 segmentation_descriptor segmentation_upid as a hex string.
        
        SegmentationUpidType (integer) -- SCTE-35 segmentation_descriptor segmentation_upid_type.
        
        SegmentsExpected (integer) -- SCTE-35 segmentation_descriptor segments_expected.
        
        SubSegmentNum (integer) -- SCTE-35 segmentation_descriptor sub_segment_num.
        
        SubSegmentsExpected (integer) -- SCTE-35 segmentation_descriptor sub_segments_expected.
        
        StaticImageActivateSettings (dict) -- Static Image Activate
        
        Duration (integer) -- The duration in milliseconds for the image to remain in the video. If omitted or set to 0, duration is infinite and image will remain until explicitly deactivated.
        
        FadeIn (integer) -- The time in milliseconds for the image to fade in. Defaults to 0.
        
        FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
        
        Height (integer) -- The height of the image when inserted into the video. Defaults to the native height of the image.
        
        Image (dict) -- The image to overlay on the video. Must be a 32 bit BMP, PNG, or TGA file. Must not be larger 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 image on the horizontal axis in pixels. 0 is the left edge of the frame. Defaults to 0.
        
        ImageY (integer) -- Placement of the top edge of the image on the vertical axis in pixels. 0 is the top edge of the frame. Defaults to 0.
        
        Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
        
        Opacity (integer) -- Opacity of image where 0 is transparent and 100 is fully opaque. Defaults to 100.
        
        Width (integer) -- The width of the image when inserted into the video. Defaults to the native width of the image.
        
        StaticImageDeactivateSettings (dict) -- Static Image Deactivate
        
        FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
        
        Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
      - ScheduleActionStartSettings (dict) -- When the action takes effect.
        
        FixedModeScheduleActionStartSettings (dict) -- Fixed timestamp action start. Conforms to ISO-8601.
        
        Time (string) -- Fixed timestamp action start. Conforms to ISO-8601.
- Deletes (dict) -- Schedule actions deleted from the schedule.
  - ScheduleActions (list) -- Returned list of deleted schedule actions.
    - (dict) -- A single schedule action.
      - ActionName (string) -- The name of the action, must be unique within the schedule.
      - ScheduleActionSettings (dict) -- Settings for this schedule action.
        
        Scte35ReturnToNetworkSettings (dict) -- SCTE-35 Return to Network Settings
        
        SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
        
        Scte35SpliceInsertSettings (dict) -- SCTE-35 Splice Insert Settings
        
        Duration (integer) -- The duration for the SCTE-35 splice_insert specified in 90KHz clock ticks. When duration is not specified the expectation is that a Scte35ReturnToNetwork action will be scheduled.
        
        SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
        
        Scte35TimeSignalSettings (dict) -- SCTE-35 Time Signal Settings
        
        Scte35Descriptors (list) -- The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
        
        (dict) -- SCTE-35 Descriptor.
        
        Scte35DescriptorSettings (dict) -- SCTE-35 Descriptor Settings.
        
        SegmentationDescriptorScte35DescriptorSettings (dict) -- SCTE-35 Segmentation Descriptor.
        
        DeliveryRestrictions (dict) -- SCTE-35 delivery restrictions.
        
        ArchiveAllowedFlag (string) -- SCTE-35 segmentation_descriptor archive_allowed_flag.
        
        DeviceRestrictions (string) -- SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        NoRegionalBlackoutFlag (string) -- SCTE-35 segmentation_descriptor no_regional_blackout_flag.
        
        WebDeliveryAllowedFlag (string) -- SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        SegmentNum (integer) -- SCTE-35 segmentation_descriptor segment_num.
        
        SegmentationCancelIndicator (string) -- SCTE-35 segmentation_descriptor segmentation_event_cancel_indicator.
        
        SegmentationDuration (integer) -- SCTE-35 segmentation_descriptor segmentation_duration specified in 90 KHz clock ticks.
        
        SegmentationEventId (integer) -- SCTE-35 segmentation_descriptor segmentation_event_id.
        
        SegmentationTypeId (integer) -- SCTE-35 segmentation_descriptor segmentation_type_id.
        
        SegmentationUpid (string) -- SCTE-35 segmentation_descriptor segmentation_upid as a hex string.
        
        SegmentationUpidType (integer) -- SCTE-35 segmentation_descriptor segmentation_upid_type.
        
        SegmentsExpected (integer) -- SCTE-35 segmentation_descriptor segments_expected.
        
        SubSegmentNum (integer) -- SCTE-35 segmentation_descriptor sub_segment_num.
        
        SubSegmentsExpected (integer) -- SCTE-35 segmentation_descriptor sub_segments_expected.
        
        StaticImageActivateSettings (dict) -- Static Image Activate
        
        Duration (integer) -- The duration in milliseconds for the image to remain in the video. If omitted or set to 0, duration is infinite and image will remain until explicitly deactivated.
        
        FadeIn (integer) -- The time in milliseconds for the image to fade in. Defaults to 0.
        
        FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
        
        Height (integer) -- The height of the image when inserted into the video. Defaults to the native height of the image.
        
        Image (dict) -- The image to overlay on the video. Must be a 32 bit BMP, PNG, or TGA file. Must not be larger 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 image on the horizontal axis in pixels. 0 is the left edge of the frame. Defaults to 0.
        
        ImageY (integer) -- Placement of the top edge of the image on the vertical axis in pixels. 0 is the top edge of the frame. Defaults to 0.
        
        Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
        
        Opacity (integer) -- Opacity of image where 0 is transparent and 100 is fully opaque. Defaults to 100.
        
        Width (integer) -- The width of the image when inserted into the video. Defaults to the native width of the image.
        
        StaticImageDeactivateSettings (dict) -- Static Image Deactivate
        
        FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
        
        Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
      - ScheduleActionStartSettings (dict) -- When the action takes effect.
        
        FixedModeScheduleActionStartSettings (dict) -- Fixed timestamp action start. Conforms to ISO-8601.
        
        Time (string) -- Fixed timestamp action start. Conforms to ISO-8601.

DescribeSchedule (new)

Link ¶

Get a channel schedule

See also: AWS API Documentation

Request Syntax

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

type ChannelId:

string

param ChannelId:

[REQUIRED] Id of the channel whose schedule is being updated.

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'ScheduleActions': [
        {
            'ActionName': 'string',
            'ScheduleActionSettings': {
                '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'
                }
            }
        },
    ]
}

Response Structure

(dict) -- An array of channel schedule actions.
- NextToken (string) -- The next token; for use in pagination.
- ScheduleActions (list) -- The list of schedule actions.
  - (dict) -- A single schedule action.
    - ActionName (string) -- The name of the action, must be unique within the schedule.
    - ScheduleActionSettings (dict) -- Settings for this schedule action.
      - Scte35ReturnToNetworkSettings (dict) -- SCTE-35 Return to Network Settings
        
        SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
      - Scte35SpliceInsertSettings (dict) -- SCTE-35 Splice Insert Settings
        
        Duration (integer) -- The duration for the SCTE-35 splice_insert specified in 90KHz clock ticks. When duration is not specified the expectation is that a Scte35ReturnToNetwork action will be scheduled.
        
        SpliceEventId (integer) -- The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
      - Scte35TimeSignalSettings (dict) -- SCTE-35 Time Signal Settings
        
        Scte35Descriptors (list) -- The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
        
        (dict) -- SCTE-35 Descriptor.
        
        Scte35DescriptorSettings (dict) -- SCTE-35 Descriptor Settings.
        
        SegmentationDescriptorScte35DescriptorSettings (dict) -- SCTE-35 Segmentation Descriptor.
        
        DeliveryRestrictions (dict) -- SCTE-35 delivery restrictions.
        
        ArchiveAllowedFlag (string) -- SCTE-35 segmentation_descriptor archive_allowed_flag.
        
        DeviceRestrictions (string) -- SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        NoRegionalBlackoutFlag (string) -- SCTE-35 segmentation_descriptor no_regional_blackout_flag.
        
        WebDeliveryAllowedFlag (string) -- SCTE-35 segmentation_descriptor web_delivery_allowed_flag.
        
        SegmentNum (integer) -- SCTE-35 segmentation_descriptor segment_num.
        
        SegmentationCancelIndicator (string) -- SCTE-35 segmentation_descriptor segmentation_event_cancel_indicator.
        
        SegmentationDuration (integer) -- SCTE-35 segmentation_descriptor segmentation_duration specified in 90 KHz clock ticks.
        
        SegmentationEventId (integer) -- SCTE-35 segmentation_descriptor segmentation_event_id.
        
        SegmentationTypeId (integer) -- SCTE-35 segmentation_descriptor segmentation_type_id.
        
        SegmentationUpid (string) -- SCTE-35 segmentation_descriptor segmentation_upid as a hex string.
        
        SegmentationUpidType (integer) -- SCTE-35 segmentation_descriptor segmentation_upid_type.
        
        SegmentsExpected (integer) -- SCTE-35 segmentation_descriptor segments_expected.
        
        SubSegmentNum (integer) -- SCTE-35 segmentation_descriptor sub_segment_num.
        
        SubSegmentsExpected (integer) -- SCTE-35 segmentation_descriptor sub_segments_expected.
      - StaticImageActivateSettings (dict) -- Static Image Activate
        
        Duration (integer) -- The duration in milliseconds for the image to remain in the video. If omitted or set to 0, duration is infinite and image will remain until explicitly deactivated.
        
        FadeIn (integer) -- The time in milliseconds for the image to fade in. Defaults to 0.
        
        FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
        
        Height (integer) -- The height of the image when inserted into the video. Defaults to the native height of the image.
        
        Image (dict) -- The image to overlay on the video. Must be a 32 bit BMP, PNG, or TGA file. Must not be larger 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 image on the horizontal axis in pixels. 0 is the left edge of the frame. Defaults to 0.
        
        ImageY (integer) -- Placement of the top edge of the image on the vertical axis in pixels. 0 is the top edge of the frame. Defaults to 0.
        
        Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
        
        Opacity (integer) -- Opacity of image where 0 is transparent and 100 is fully opaque. Defaults to 100.
        
        Width (integer) -- The width of the image when inserted into the video. Defaults to the native width of the image.
      - StaticImageDeactivateSettings (dict) -- Static Image Deactivate
        
        FadeOut (integer) -- The time in milliseconds for the image to fade out. Defaults to 0.
        
        Layer (integer) -- The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0.
    - ScheduleActionStartSettings (dict) -- When the action takes effect.
      - FixedModeScheduleActionStartSettings (dict) -- Fixed timestamp action start. Conforms to ISO-8601.
        
        Time (string) -- Fixed timestamp action start. Conforms to ISO-8601.