CreateProgram
Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
Request Syntax
POST /channel/ChannelName/program/ProgramName HTTP/1.1
Content-type: application/json
{
"AdBreaks": [
{
"AdBreakMetadata": [
{
"Key": "string",
"Value": "string"
}
],
"MessageType": "string",
"OffsetMillis": number,
"Slate": {
"SourceLocationName": "string",
"VodSourceName": "string"
},
"SpliceInsertMessage": {
"AvailNum": number,
"AvailsExpected": number,
"SpliceEventId": number,
"UniqueProgramId": number
},
"TimeSignalMessage": {
"SegmentationDescriptors": [
{
"SegmentationEventId": number,
"SegmentationTypeId": number,
"SegmentationUpid": "string",
"SegmentationUpidType": number,
"SegmentNum": number,
"SegmentsExpected": number,
"SubSegmentNum": number,
"SubSegmentsExpected": number
}
]
}
}
],
"AudienceMedia": [
{
"AlternateMedia": [
{
"AdBreaks": [
{
"AdBreakMetadata": [
{
"Key": "string",
"Value": "string"
}
],
"MessageType": "string",
"OffsetMillis": number,
"Slate": {
"SourceLocationName": "string",
"VodSourceName": "string"
},
"SpliceInsertMessage": {
"AvailNum": number,
"AvailsExpected": number,
"SpliceEventId": number,
"UniqueProgramId": number
},
"TimeSignalMessage": {
"SegmentationDescriptors": [
{
"SegmentationEventId": number,
"SegmentationTypeId": number,
"SegmentationUpid": "string",
"SegmentationUpidType": number,
"SegmentNum": number,
"SegmentsExpected": number,
"SubSegmentNum": number,
"SubSegmentsExpected": number
}
]
}
}
],
"ClipRange": {
"EndOffsetMillis": number,
"StartOffsetMillis": number
},
"DurationMillis": number,
"LiveSourceName": "string",
"ScheduledStartTimeMillis": number,
"SourceLocationName": "string",
"VodSourceName": "string"
}
],
"Audience": "string"
}
],
"LiveSourceName": "string",
"ScheduleConfiguration": {
"ClipRange": {
"EndOffsetMillis": number,
"StartOffsetMillis": number
},
"Transition": {
"DurationMillis": number,
"RelativePosition": "string",
"RelativeProgram": "string",
"ScheduledStartTimeMillis": number,
"Type": "string"
}
},
"SourceLocationName": "string",
"VodSourceName": "string"
}URI Request Parameters
The request uses the following URI parameters.
- ChannelName
-
The name of the channel for this Program.
Required: Yes
- ProgramName
-
The name of the Program.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- AdBreaks
-
The ad break configuration settings.
Type: Array of AdBreak objects
Required: No
- AudienceMedia
-
The list of AudienceMedia defined in program.
Type: Array of AudienceMedia objects
Required: No
- LiveSourceName
-
The name of the LiveSource for this Program.
Type: String
Required: No
- ScheduleConfiguration
-
The schedule configuration settings.
Type: ScheduleConfiguration object
Required: Yes
- SourceLocationName
-
The name of the source location.
Type: String
Required: Yes
- VodSourceName
-
The name that's used to refer to a VOD source.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AdBreaks": [
{
"AdBreakMetadata": [
{
"Key": "string",
"Value": "string"
}
],
"MessageType": "string",
"OffsetMillis": number,
"Slate": {
"SourceLocationName": "string",
"VodSourceName": "string"
},
"SpliceInsertMessage": {
"AvailNum": number,
"AvailsExpected": number,
"SpliceEventId": number,
"UniqueProgramId": number
},
"TimeSignalMessage": {
"SegmentationDescriptors": [
{
"SegmentationEventId": number,
"SegmentationTypeId": number,
"SegmentationUpid": "string",
"SegmentationUpidType": number,
"SegmentNum": number,
"SegmentsExpected": number,
"SubSegmentNum": number,
"SubSegmentsExpected": number
}
]
}
}
],
"Arn": "string",
"AudienceMedia": [
{
"AlternateMedia": [
{
"AdBreaks": [
{
"AdBreakMetadata": [
{
"Key": "string",
"Value": "string"
}
],
"MessageType": "string",
"OffsetMillis": number,
"Slate": {
"SourceLocationName": "string",
"VodSourceName": "string"
},
"SpliceInsertMessage": {
"AvailNum": number,
"AvailsExpected": number,
"SpliceEventId": number,
"UniqueProgramId": number
},
"TimeSignalMessage": {
"SegmentationDescriptors": [
{
"SegmentationEventId": number,
"SegmentationTypeId": number,
"SegmentationUpid": "string",
"SegmentationUpidType": number,
"SegmentNum": number,
"SegmentsExpected": number,
"SubSegmentNum": number,
"SubSegmentsExpected": number
}
]
}
}
],
"ClipRange": {
"EndOffsetMillis": number,
"StartOffsetMillis": number
},
"DurationMillis": number,
"LiveSourceName": "string",
"ScheduledStartTimeMillis": number,
"SourceLocationName": "string",
"VodSourceName": "string"
}
],
"Audience": "string"
}
],
"ChannelName": "string",
"ClipRange": {
"EndOffsetMillis": number,
"StartOffsetMillis": number
},
"CreationTime": number,
"DurationMillis": number,
"LiveSourceName": "string",
"ProgramName": "string",
"ScheduledStartTime": number,
"SourceLocationName": "string",
"VodSourceName": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AdBreaks
-
The ad break configuration settings.
Type: Array of AdBreak objects
- Arn
-
The ARN to assign to the program.
Type: String
- AudienceMedia
-
The list of AudienceMedia defined in program.
Type: Array of AudienceMedia objects
- ChannelName
-
The name to assign to the channel for this program.
Type: String
- ClipRange
-
The clip range configuration settings.
Type: ClipRange object
- CreationTime
-
The time the program was created.
Type: Timestamp
- DurationMillis
-
The duration of the live program in milliseconds.
Type: Long
- LiveSourceName
-
The name of the LiveSource for this Program.
Type: String
- ProgramName
-
The name to assign to this program.
Type: String
- ScheduledStartTime
-
The scheduled start time for this Program.
Type: Timestamp
- SourceLocationName
-
The name to assign to the source location for this program.
Type: String
- VodSourceName
-
The name that's used to refer to a VOD source.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
