schedules
Creates, updates, deletes, gets or lists a schedules resource.
Overview
| Name | schedules |
| Type | Resource |
| Id | aws.medialive.schedules |
Fields
The following fields are returned by SELECT queries:
- describe_schedule
| Name | Datatype | Description |
|---|---|---|
action_name | string | Placeholder documentation for __string |
schedule_action_settings | object | Settings for this schedule action. |
schedule_action_start_settings | object | The time for the action to start in the channel. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_schedule | select | channel_id, region | maxResults, nextToken | Get a channel schedule |
delete_schedule | delete | channel_id, region | Delete all schedule actions on a channel. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
channel_id | string | Id of the channel whose schedule is being deleted. |
region | string | AWS region (default: us-east-1) |
maxResults | integer | |
nextToken | string |
SELECT examples
- describe_schedule
Get a channel schedule
SELECT
action_name,
schedule_action_settings,
schedule_action_start_settings
FROM aws.medialive.schedules
WHERE channel_id = '{{ channel_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;
DELETE examples
- delete_schedule
Delete all schedule actions on a channel.
DELETE FROM aws.medialive.schedules
WHERE channel_id = '{{ channel_id }}' --required
AND region = '{{ region }}' --required
;