Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetChannelSchedule

Retrieves information about your channel's schedule.

Request Syntax


GET /channel/ChannelName/schedule?audience=Audience&durationMinutes=DurationMinutes&maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Audience

The single audience for GetChannelScheduleRequest.

ChannelName

The name of the channel associated with this Channel Schedule.

Required: Yes

DurationMinutes

The duration in minutes of the channel schedule.

MaxResults

The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.

For the first GetChannelScheduleRequest request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

If the previous response didn't include a NextToken element, there are no more channel schedules to get.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ApproximateDurationSeconds": number,
         "ApproximateStartTime": number,
         "Arn": "string",
         "Audiences": [ "string" ],
         "ChannelName": "string",
         "LiveSourceName": "string",
         "ProgramName": "string",
         "ScheduleAdBreaks": [ 
            { 
               "ApproximateDurationSeconds": number,
               "ApproximateStartTime": number,
               "SourceLocationName": "string",
               "VodSourceName": "string"
            }
         ],
         "ScheduleEntryType": "string",
         "SourceLocationName": "string",
         "VodSourceName": "string"
      }
   ],
   "NextToken": "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.

Items

A list of schedule entries for the channel.

Type: Array of ScheduleEntry objects

NextToken

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.