1---2name: aws-mediatailor3description: AWS MediaTailor API skill. Use when working with AWS MediaTailor for configureLogs, channel, sourceLocation. Covers 44 endpoints.4---5
6# AWS MediaTailor
7API version: 2018-04-23
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /alerts -- verify access
183. POST /channel/{ChannelName} -- create first channel
19
20## Endpoints
21
2244 endpoints across 10 groups. See references/api-spec.lap for full details.
23
24### configureLogs
25| Method | Path | Description |
26|--------|------|-------------|
27| PUT | /configureLogs/channel | Configures Amazon CloudWatch log settings for a channel. |
28| PUT | /configureLogs/playbackConfiguration | Amazon CloudWatch log settings for a playback configuration. |
29
30### channel
31| Method | Path | Description |
32|--------|------|-------------|
33| POST | /channel/{ChannelName} | Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide. |
34| POST | /channel/{ChannelName}/program/{ProgramName} | Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide. |
35| DELETE | /channel/{ChannelName} | Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide. |
36| DELETE | /channel/{ChannelName}/policy | The channel policy to delete. |
37| DELETE | /channel/{ChannelName}/program/{ProgramName} | Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide. |
38| GET | /channel/{ChannelName} | Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide. |
39| GET | /channel/{ChannelName}/program/{ProgramName} | Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide. |
40| GET | /channel/{ChannelName}/policy | Returns the channel's IAM policy. IAM policies are used to control access to your channel. |
41| GET | /channel/{ChannelName}/schedule | Retrieves information about your channel's schedule. |
42| PUT | /channel/{ChannelName}/policy | Creates an IAM policy for the channel. IAM policies are used to control access to your channel. |
43| PUT | /channel/{ChannelName}/start | Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide. |
44| PUT | /channel/{ChannelName}/stop | Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide. |
45| PUT | /channel/{ChannelName} | Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide. |
46| PUT | /channel/{ChannelName}/program/{ProgramName} | Updates a program within a channel. |
47
48### sourceLocation
49| Method | Path | Description |
50|--------|------|-------------|
51| POST | /sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName} | The live source configuration. |
52| POST | /sourceLocation/{SourceLocationName} | Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide. |
53| POST | /sourceLocation/{SourceLocationName}/vodSource/{VodSourceName} | The VOD source configuration parameters. |
54| DELETE | /sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName} | The live source to delete. |
55| DELETE | /sourceLocation/{SourceLocationName} | Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide. |
56| DELETE | /sourceLocation/{SourceLocationName}/vodSource/{VodSourceName} | The video on demand (VOD) source to delete. |
57| GET | /sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName} | The live source to describe. |
58| GET | /sourceLocation/{SourceLocationName} | Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide. |
59| GET | /sourceLocation/{SourceLocationName}/vodSource/{VodSourceName} | Provides details about a specific video on demand (VOD) source in a specific source location. |
60| GET | /sourceLocation/{SourceLocationName}/liveSources | Lists the live sources contained in a source location. A source represents a piece of content. |
61| GET | /sourceLocation/{SourceLocationName}/vodSources | Lists the VOD sources contained in a source location. A source represents a piece of content. |
62| PUT | /sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName} | Updates a live source's configuration. |
63| PUT | /sourceLocation/{SourceLocationName} | Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide. |
64| PUT | /sourceLocation/{SourceLocationName}/vodSource/{VodSourceName} | Updates a VOD source's configuration. |
65
66### prefetchSchedule
67| Method | Path | Description |
68|--------|------|-------------|
69| POST | /prefetchSchedule/{PlaybackConfigurationName}/{Name} | Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide. |
70| DELETE | /prefetchSchedule/{PlaybackConfigurationName}/{Name} | Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide. |
71| GET | /prefetchSchedule/{PlaybackConfigurationName}/{Name} | Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide. |
72| POST | /prefetchSchedule/{PlaybackConfigurationName} | Lists the prefetch schedules for a playback configuration. |
73
74### playbackConfiguration
75| Method | Path | Description |
76|--------|------|-------------|
77| DELETE | /playbackConfiguration/{Name} | Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor. |
78| GET | /playbackConfiguration/{Name} | Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor. |
79| PUT | /playbackConfiguration | Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor. |
80
81### alerts
82| Method | Path | Description |
83|--------|------|-------------|
84| GET | /alerts | Lists the alerts that are associated with a MediaTailor channel assembly resource. |
85
86### channels
87| Method | Path | Description |
88|--------|------|-------------|
89| GET | /channels | Retrieves information about the channels that are associated with the current AWS account. |
90
91### playbackConfigurations
92| Method | Path | Description |
93|--------|------|-------------|
94| GET | /playbackConfigurations | Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor. |
95
96### sourceLocations
97| Method | Path | Description |
98|--------|------|-------------|
99| GET | /sourceLocations | Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources. |
100
101### tags
102| Method | Path | Description |
103|--------|------|-------------|
104| GET | /tags/{ResourceArn} | A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources. |
105| POST | /tags/{ResourceArn} | The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources. |
106| DELETE | /tags/{ResourceArn} | The resource to untag. |
107
108## Common Questions
109
110Match user requests to endpoints in references/api-spec.lap. Key patterns:
111- "Delete a channel?" -> DELETE /channel/{ChannelName}
112- "Delete a liveSource?" -> DELETE /sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}
113- "Delete a playbackConfiguration?" -> DELETE /playbackConfiguration/{Name}
114- "Delete a prefetchSchedule?" -> DELETE /prefetchSchedule/{PlaybackConfigurationName}/{Name}
115- "Delete a program?" -> DELETE /channel/{ChannelName}/program/{ProgramName}
116- "Delete a sourceLocation?" -> DELETE /sourceLocation/{SourceLocationName}
117- "Delete a vodSource?" -> DELETE /sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}
118- "Get channel details?" -> GET /channel/{ChannelName}
119- "Get liveSource details?" -> GET /sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}
120- "Get program details?" -> GET /channel/{ChannelName}/program/{ProgramName}
121- "Get sourceLocation details?" -> GET /sourceLocation/{SourceLocationName}
122- "Get vodSource details?" -> GET /sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}
123- "List all policy?" -> GET /channel/{ChannelName}/policy
124- "List all schedule?" -> GET /channel/{ChannelName}/schedule
125- "Get playbackConfiguration details?" -> GET /playbackConfiguration/{Name}
126- "Get prefetchSchedule details?" -> GET /prefetchSchedule/{PlaybackConfigurationName}/{Name}
127- "List all alerts?" -> GET /alerts
128- "List all channels?" -> GET /channels
129- "List all liveSources?" -> GET /sourceLocation/{SourceLocationName}/liveSources
130- "List all playbackConfigurations?" -> GET /playbackConfigurations
131- "List all sourceLocations?" -> GET /sourceLocations
132- "Get tag details?" -> GET /tags/{ResourceArn}
133- "List all vodSources?" -> GET /sourceLocation/{SourceLocationName}/vodSources
134- "Delete a tag?" -> DELETE /tags/{ResourceArn}
135- "Update a channel?" -> PUT /channel/{ChannelName}
136- "Update a liveSource?" -> PUT /sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}
137- "Update a program?" -> PUT /channel/{ChannelName}/program/{ProgramName}
138- "Update a sourceLocation?" -> PUT /sourceLocation/{SourceLocationName}
139- "Update a vodSource?" -> PUT /sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}
140- "How to authenticate?" -> See Auth section
141
142## Response Tips
143- Check response schemas in references/api-spec.lap for field details
144- Create/update endpoints typically return the created/updated object
145
146## References
147- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
148
149> Generated from the official API spec by [LAP](https://lap.sh)
Lap-Platform