| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.MediaTailor.GetChannelSchedule
Description
Retrieves information about your channel's schedule.
This operation returns paginated results.
Synopsis
- data GetChannelSchedule = GetChannelSchedule' {}
- newGetChannelSchedule :: Text -> GetChannelSchedule
- getChannelSchedule_durationMinutes :: Lens' GetChannelSchedule (Maybe Text)
- getChannelSchedule_maxResults :: Lens' GetChannelSchedule (Maybe Natural)
- getChannelSchedule_nextToken :: Lens' GetChannelSchedule (Maybe Text)
- getChannelSchedule_channelName :: Lens' GetChannelSchedule Text
- data GetChannelScheduleResponse = GetChannelScheduleResponse' {
- items :: Maybe [ScheduleEntry]
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetChannelScheduleResponse :: Int -> GetChannelScheduleResponse
- getChannelScheduleResponse_items :: Lens' GetChannelScheduleResponse (Maybe [ScheduleEntry])
- getChannelScheduleResponse_nextToken :: Lens' GetChannelScheduleResponse (Maybe Text)
- getChannelScheduleResponse_httpStatus :: Lens' GetChannelScheduleResponse Int
Creating a Request
data GetChannelSchedule Source #
See: newGetChannelSchedule smart constructor.
Constructors
| GetChannelSchedule' | |
Fields
| |
Instances
newGetChannelSchedule Source #
Arguments
| :: Text | |
| -> GetChannelSchedule |
Create a value of GetChannelSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationMinutes:GetChannelSchedule', getChannelSchedule_durationMinutes - The duration in minutes of the channel schedule.
$sel:maxResults:GetChannelSchedule', getChannelSchedule_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.
GetChannelSchedule, getChannelSchedule_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.
GetChannelSchedule, getChannelSchedule_channelName - The name of the channel associated with this Channel Schedule.
Request Lenses
getChannelSchedule_durationMinutes :: Lens' GetChannelSchedule (Maybe Text) Source #
The duration in minutes of the channel schedule.
getChannelSchedule_maxResults :: Lens' GetChannelSchedule (Maybe Natural) Source #
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.
getChannelSchedule_nextToken :: Lens' GetChannelSchedule (Maybe Text) Source #
(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.
getChannelSchedule_channelName :: Lens' GetChannelSchedule Text Source #
The name of the channel associated with this Channel Schedule.
Destructuring the Response
data GetChannelScheduleResponse Source #
See: newGetChannelScheduleResponse smart constructor.
Constructors
| GetChannelScheduleResponse' | |
Fields
| |
Instances
newGetChannelScheduleResponse Source #
Create a value of GetChannelScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:GetChannelScheduleResponse', getChannelScheduleResponse_items - A list of schedule entries for the channel.
GetChannelSchedule, getChannelScheduleResponse_nextToken - Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
$sel:httpStatus:GetChannelScheduleResponse', getChannelScheduleResponse_httpStatus - The response's http status code.
Response Lenses
getChannelScheduleResponse_items :: Lens' GetChannelScheduleResponse (Maybe [ScheduleEntry]) Source #
A list of schedule entries for the channel.
getChannelScheduleResponse_nextToken :: Lens' GetChannelScheduleResponse (Maybe Text) Source #
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
getChannelScheduleResponse_httpStatus :: Lens' GetChannelScheduleResponse Int Source #
The response's http status code.