DescribeProgram
Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
Request Syntax
GET /channel/ChannelName/program/ProgramName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ChannelName
-
The name of the channel associated with this Program.
Required: Yes
- ProgramName
-
The name of the program.
Required: Yes
Request Body
The request does not have a request body.
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 of the program.
Type: String
- AudienceMedia
-
The list of AudienceMedia defined in program.
Type: Array of AudienceMedia objects
- ChannelName
-
The name of the channel that the program belongs to.
Type: String
- ClipRange
-
The clip range configuration settings.
Type: ClipRange object
- CreationTime
-
The timestamp of when 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 of the program.
Type: String
- ScheduledStartTime
-
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
Type: Timestamp
- SourceLocationName
-
The source location name.
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:
