| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.MediaTailor.GetChannelSchedule
Description
Retrieves information about your channel's schedule.
This operation returns paginated results.
Synopsis
- data GetChannelSchedule = GetChannelSchedule' {}
- newGetChannelSchedule :: Text -> GetChannelSchedule
- getChannelSchedule_nextToken :: Lens' GetChannelSchedule (Maybe Text)
- getChannelSchedule_durationMinutes :: Lens' GetChannelSchedule (Maybe Text)
- getChannelSchedule_maxResults :: Lens' GetChannelSchedule (Maybe Natural)
- 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:nextToken:GetChannelSchedule', getChannelSchedule_nextToken - Pagination token from the GET list request. Use the token to fetch the
next page of results.
$sel:durationMinutes:GetChannelSchedule', getChannelSchedule_durationMinutes - The schedule duration in minutes. The maximum duration is 4320 minutes
(three days).
$sel:maxResults:GetChannelSchedule', getChannelSchedule_maxResults - Upper bound on number of records to return. The maximum number of
results is 100.
$sel:channelName:GetChannelSchedule', getChannelSchedule_channelName - The identifier for the channel you are working on.
Request Lenses
getChannelSchedule_nextToken :: Lens' GetChannelSchedule (Maybe Text) Source #
Pagination token from the GET list request. Use the token to fetch the next page of results.
getChannelSchedule_durationMinutes :: Lens' GetChannelSchedule (Maybe Text) Source #
The schedule duration in minutes. The maximum duration is 4320 minutes (three days).
getChannelSchedule_maxResults :: Lens' GetChannelSchedule (Maybe Natural) Source #
Upper bound on number of records to return. The maximum number of results is 100.
getChannelSchedule_channelName :: Lens' GetChannelSchedule Text Source #
The identifier for the channel you are working on.
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 - An array of schedule entries for the channel.
$sel:nextToken:GetChannelSchedule', getChannelScheduleResponse_nextToken - Pagination token from the GET list request. 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 #
An array of schedule entries for the channel.
getChannelScheduleResponse_nextToken :: Lens' GetChannelScheduleResponse (Maybe Text) Source #
Pagination token from the GET list request. Use the token to fetch the next page of results.
getChannelScheduleResponse_httpStatus :: Lens' GetChannelScheduleResponse Int Source #
The response's http status code.