AWS MediaTailor

{'Items': {'ScheduleAdBreaks': [{'ApproximateDurationSeconds': 'long',
                                 'ApproximateStartTime': 'timestamp',
                                 'SourceLocationName': 'string',
                                 'VodSourceName': 'string'}]}}

Retrieves information about your channel's schedule.

See also: AWS API Documentation

Request Syntax

client.get_channel_schedule(
    ChannelName='string',
    DurationMinutes='string',
    MaxResults=123,
    NextToken='string'
)

type ChannelName

string

param ChannelName

[REQUIRED]

The identifier for the channel you are working on.

type DurationMinutes

string

param DurationMinutes

The schedule duration in minutes. The maximum duration is 4320 minutes (three days).

type MaxResults

integer

param MaxResults

Upper bound on number of records to return. The maximum number of results is 100.

type NextToken

string

param NextToken

Pagination token from the GET list request. Use the token to fetch the next page of results.

rtype

dict

returns

Response Syntax

{
    'Items': [
        {
            'ApproximateDurationSeconds': 123,
            'ApproximateStartTime': datetime(2015, 1, 1),
            'Arn': 'string',
            'ChannelName': 'string',
            'ProgramName': 'string',
            'ScheduleAdBreaks': [
                {
                    'ApproximateDurationSeconds': 123,
                    'ApproximateStartTime': datetime(2015, 1, 1),
                    'SourceLocationName': 'string',
                    'VodSourceName': 'string'
                },
            ],
            'SourceLocationName': 'string',
            'VodSourceName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Success.

  • Items (list) --

    An array of schedule entries for the channel.

    • (dict) --

      The properties for a schedule.

      • ApproximateDurationSeconds (integer) --

        The approximate duration of this program, in seconds.

      • ApproximateStartTime (datetime) --

        The approximate time that the program will start playing.

      • Arn (string) --

        The ARN of the program.

      • ChannelName (string) --

        The name of the channel that uses this schedule.

      • ProgramName (string) --

        The name of the program.

      • ScheduleAdBreaks (list) --

        The schedule's ad break properties.

        • (dict) --

          The schedule's ad break properties.

          • ApproximateDurationSeconds (integer) --

            The approximate duration of the ad break, in seconds.

          • ApproximateStartTime (datetime) --

            The approximate time that the ad will start playing.

          • SourceLocationName (string) --

            The name of the source location containing the VOD source used for the ad break.

          • VodSourceName (string) --

            The name of the VOD source used for the ad break.

      • SourceLocationName (string) --

        The name of the source location.

      • VodSourceName (string) --

        The name of the VOD source.

  • NextToken (string) --

    Pagination token from the GET list request. Use the token to fetch the next page of results.